REST Services Manager API for Billing and Revenue Management

Get Top-up Balances

get

/topupBalance

Gets top-up balances that match the query criteria.

Request

Query Parameters

bucket.id: string
Retrieves the top-up balance associated with the balance group POID.
Example:
```
0.0.0.1+-balance_group+71659
```
fields: string
The list of comma-separated fields to return in the response.
Example:
```
isAutoTopup,paymentMethod
```
id: string
Retrieves the specified top-up POID.
Example:
```
0.0.0.1+-topup+285083
```
isAutoTopup: boolean
The value indicates whether the request is for an automatic top up.
Example:
```
true
```
limit: integer
The maximum number of results to return. For example, use limit=10 to return the first 10 results only.
Example:
```
10
```
logicalResource.value: string
Retrieves the top-up balance associated with the login ID or device ID.
Example:
```
964-20210827-041409-0-9169--146802944-mum-54
```
numberOfPeriods: integer
The number of periods to execute the recharge operation. If not included, the topup occurs every period.
Example:
```
2
```
offset: integer
The number of results to offset the response by. For example, use offset=10 to return results 10 and higher.
Example:
```
10
```
partyAccount.id: string
Retrieves the top-up balance associated with the account external ID or account POID.

Examples
product.id: string
Retrieves the top-up balance associated with the specified service ID, login ID or alias name.

Examples
recurringPeriod: string
The periodicity for the recharge operation, such as monthly, weekly, or daily.
Example:
```
daily
```
usageType: string
The type of underlying balance type, such as data or voice.
Example:
```
data
```

There's no request body for this operation.

Response

Supported Media Types

application/json;charset=utf-8

200 Response

The top-up balances were retrieved successfully.

Headers

X-Result-Count:

The number of items returned in the response body.
X-Total-Count:

The total number of items that matched the criteria.

Root Schema : schema

Type: array

Show Source

Array of: object Topup Balance

Title: Topup Balance

A top-up.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TopupBalance"
    }
}

Nested Schema : Topup Balance

Type: object

Title: Topup Balance

A top-up.

Show Source

@baseType: string

Title: Base Type

The object's superclass.
@schemaLocation: string (uri)

Title: Schema Location

A URI to a JSON schema file that defines additional attributes and relationships.
@type: string

Title: Type

The object's subclass.
amount: object Quantity

Represents an amount in a specified unit.
bucket: object Bucket Ref

Title: Bucket Ref

A reference to a bucket.
channel: object ChannelRef

A reference to a channel.
confirmationDate: string (date-time)

Title: Confirmation Date

The date the top-up was confirmed.
description: string

Title: Description

The top-up's description.
href: string (uri)

Title: Href

The top-up balance's href.
id: string

Title: ID

The top-up balance's ID.
impactedBucket: array impactedBucket

A reference to the bucket impacted by the request.
isAutoTopup: boolean

Title: Is Auto Topup

The value indicates whether the top-up is automatic (true) or not (false).
logicalResource: object Logical Resource Ref

Title: Logical Resource Ref

A reference to a logical resource.
numberOfPeriods: integer

Title: Number of Periods

The number of billing periods for which an automatic top-up occurs. If this property is not specified, the top-up will continue automatically indefinitely.
partyAccount: object Party Account Ref

Title: Party Account Ref

A reference to a party account.
payment: object PaymentRef

A payment received at order time.
paymentMethod: object PaymentMethodRef

PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).
product: object ProductRef

A product reference.
reason: string

Title: Reason

The reason for the top-up.
recurringPeriod: string

The type of recurring period for the top-up.
relatedParty: array relatedParty

The parties are related to the top-up.
relatedTopupBalance: object Related Topup Balance

Title: Related Topup Balance

A relationship between balance top-ups that defines whether a balance is the parent or child of another.
requestedDate: string (date-time)

Title: Requested Date

The date and time that the top-up request was made.
requestor: object Related Party

Title: Related Party

A party related to another object.
status: string

The status of the request.
usageType: string

The top-up's usage type.
voucher: string

Title: Voucher

The voucher used for the top-up.

{
    "type":"object",
    "title":"Topup Balance",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "amount":{
            "description":"The amount to be topped up.",
            "$ref":"#/components/schemas/Quantity"
        },
        "bucket":{
            "description":"The bucket tracking the top-up.",
            "$ref":"#/components/schemas/BucketRef"
        },
        "channel":{
            "description":"The top-up channel.",
            "$ref":"#/components/schemas/ChannelRef"
        },
        "confirmationDate":{
            "type":"string",
            "title":"Confirmation Date",
            "description":"The date the top-up was confirmed.",
            "format":"date-time"
        },
        "description":{
            "type":"string",
            "title":"Description",
            "description":"The top-up's description."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The top-up balance's href.",
            "format":"uri"
        },
        "id":{
            "type":"string",
            "title":"ID",
            "description":"The top-up balance's ID."
        },
        "impactedBucket":{
            "type":"array",
            "description":"A reference to the bucket impacted by the request.",
            "items":{
                "$ref":"#/components/schemas/ImpactedBucket"
            }
        },
        "isAutoTopup":{
            "type":"boolean",
            "title":"Is Auto Topup",
            "description":"The value indicates whether the top-up is automatic (<b>true</b>) or not (<b>false</b>)."
        },
        "logicalResource":{
            "description":"A logical resource associated with the top-up.",
            "$ref":"#/components/schemas/LogicalResourceRef"
        },
        "numberOfPeriods":{
            "type":"integer",
            "title":"Number of Periods",
            "description":"The number of billing periods for which an automatic top-up occurs. If this property is not specified, the top-up will continue automatically indefinitely."
        },
        "partyAccount":{
            "description":"A party account associated with the top-up.",
            "$ref":"#/components/schemas/PartyAccountRef"
        },
        "payment":{
            "description":"A payment associated with the top-up.",
            "$ref":"#/components/schemas/PaymentRef"
        },
        "paymentMethod":{
            "description":"The payment method for the top-up.",
            "$ref":"#/components/schemas/PaymentMethodRef"
        },
        "product":{
            "description":"A product associated with the top-up.",
            "$ref":"#/components/schemas/ProductRef"
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the top-up."
        },
        "recurringPeriod":{
            "type":"string",
            "description":"The type of recurring period for the top-up."
        },
        "relatedParty":{
            "type":"array",
            "description":"The parties are related to the top-up.",
            "items":{
                "$ref":"#/components/schemas/RelatedParty"
            }
        },
        "relatedTopupBalance":{
            "description":"A balance related to the top-up. (BRM does not use this property).",
            "$ref":"#/components/schemas/RelatedTopupBalance"
        },
        "requestedDate":{
            "type":"string",
            "title":"Requested Date",
            "description":"The date and time that the top-up request was made.",
            "format":"date-time"
        },
        "requestor":{
            "description":"The party requesting the top-up.",
            "$ref":"#/components/schemas/RelatedParty"
        },
        "status":{
            "type":"string",
            "description":"The status of the request."
        },
        "usageType":{
            "type":"string",
            "description":"The top-up's usage type."
        },
        "voucher":{
            "type":"string",
            "title":"Voucher",
            "description":"The voucher used for the top-up."
        }
    },
    "description":"A top-up."
}

Nested Schema : Quantity

Type: object

Represents an amount in a specified unit.

Show Source

amount: number (double)

Default Value: 1

The numeric value in the specified unit.
units: string

The unit.

{
    "type":"object",
    "description":"Represents an amount in a specified unit.",
    "properties":{
        "amount":{
            "type":"number",
            "nullable":true,
            "format":"double",
            "default":1,
            "description":"The numeric value in the specified unit."
        },
        "units":{
            "type":"string",
            "nullable":true,
            "description":"The unit."
        }
    }
}

Nested Schema : Bucket Ref

Type: object

Title: Bucket Ref

A reference to a bucket.

Show Source

@baseType: string

Title: Base Type

The object's superclass.
@referredType: string

Title: Referred Type

The object's type in the target system, if baseType and type need further disambiguation.
@schemaLocation: string (uri)

Title: Schema Location

A URI to a JSON schema file that defines additional attributes and relationships.
@type: string

Title: Type

The object's subclass.
href: string (uri)

The bucket's href.
id(required): string

Title: Bucket ID

The bucket's ID.
name: string

Title: Bucket Name

The bucket's name.
usageType: string

The bucket's usage type.

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Bucket Ref",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "href":{
            "type":"string",
            "description":"The bucket's href.",
            "format":"uri"
        },
        "id":{
            "type":"string",
            "title":"Bucket ID",
            "description":"The bucket's ID."
        },
        "name":{
            "type":"string",
            "title":"Bucket Name",
            "description":"The bucket's name."
        },
        "usageType":{
            "type":"string",
            "description":"The bucket's usage type."
        }
    },
    "description":"A reference to a bucket."
}

Nested Schema : ChannelRef

Type: object

A reference to a channel.

Show Source

@baseType: string

Title: Base Type

The object's superclass.
@referredType: string

Title: Referred Type

The object's type in the target system, if baseType and type need further disambiguation.
@schemaLocation: string (uri)

Title: Schema Location

A URI to a JSON schema file that defines additional attributes and relationships.
@type: string

Title: Type

The object's subclass.
href: string

Title: Channel Href

The channel's href.
id(required): string

Title: Channel ID

The channel's ID.
name: string

Title: Channel Name

The channel's name.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "title":"Channel ID",
            "description":"The channel's ID."
        },
        "href":{
            "type":"string",
            "title":"Channel Href",
            "description":"The channel's href."
        },
        "name":{
            "type":"string",
            "title":"Channel Name",
            "description":"The channel's name."
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        }
    },
    "description":"A reference to a channel."
}

Nested Schema : impactedBucket

Type: array

A reference to the bucket impacted by the request.

Show Source

Array of: object ImpactedBucket

A bucket impacted by a balance top-up, adjustment, transfer, or reservation.

{
    "type":"array",
    "description":"A reference to the bucket impacted by the request.",
    "items":{
        "$ref":"#/components/schemas/ImpactedBucket"
    }
}

Nested Schema : Logical Resource Ref

Type: object

Title: Logical Resource Ref

A reference to a logical resource.

Show Source

@baseType: string

Title: Base Type

The object's superclass.
@referredType: string

Title: Referred Type

The object's type in the target system, if baseType and type need further disambiguation.
@schemaLocation: string (uri)

Title: Schema Location

A URI to a JSON schema file that defines additional attributes and relationships.
@type: string

Title: Type

The object's subclass.
href: string

Title: Href

The resource's href.
id(required): string

Title: ID

The resource's ID.
name: string

Title: Name

The resource's name.
value: string

The device number(PIN_FLD_ALIAS_LIST) or the login (PIN_FLD_LOGIN).

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Logical Resource Ref",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The resource's href."
        },
        "id":{
            "type":"string",
            "title":"ID",
            "description":"The resource's ID."
        },
        "name":{
            "type":"string",
            "title":"Name",
            "description":"The resource's name."
        },
        "value":{
            "type":"string",
            "description":"The device number(PIN_FLD_ALIAS_LIST) or the login (PIN_FLD_LOGIN)."
        }
    },
    "description":"A reference to a logical resource."
}

Nested Schema : Party Account Ref

Type: object

Title: Party Account Ref

A reference to a party account.

Show Source

@baseType: string

Title: Base Type

The object's superclass.
@referredType: string

Title: Referred Type

The object's type in the target system, if baseType and type need further disambiguation.
@schemaLocation: string (uri)

Title: Schema Location

A URI to a JSON schema file that defines additional attributes and relationships.
@type: string

Title: Type

The object's subclass.
description: string

Title: Description

The party account's description.
href: string

Title: Href

The party account's href.
id(required): string

Title: Account ID

The party account's ID.
name: string

Title: Name

The party account's name.
status: string

Title: Status

The overall status of the account. For example: due, paid, or in arrears.

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Party Account Ref",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "description":{
            "type":"string",
            "title":"Description",
            "description":"The party account's description."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The party account's href."
        },
        "id":{
            "type":"string",
            "title":"Account ID",
            "description":"The party account's ID."
        },
        "name":{
            "type":"string",
            "title":"Name",
            "description":"The party account's name."
        },
        "status":{
            "type":"string",
            "title":"Status",
            "description":"The overall status of the account. For example&colon; <b>due</b>, <b>paid</b>, or <b>in arrears</b>."
        }
    },
    "description":"A reference to a party account."
}

Nested Schema : PaymentRef

Type: object

A payment received at order time.

Show Source

@baseType: string

The object's superclass.
@referredType: string

The object's type in the target system, if baseType and type need further disambiguation.
@schemaLocation: string (uri)

A URI to a JSON schema file that defines additional attributes and relationships.
@type: string

The object's subclass.
href: string (uri)

The payment's href.
id(required): string

The payment's ID.
name: string

The payment's name.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "@baseType":{
            "type":"string",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"The object's subclass."
        },
        "href":{
            "type":"string",
            "description":"The payment's href.",
            "format":"uri"
        },
        "id":{
            "type":"string",
            "description":"The payment's ID."
        },
        "name":{
            "type":"string",
            "description":"The payment's name."
        }
    },
    "description":"A payment received at order time."
}

Nested Schema : PaymentMethodRef

Type: object

PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).

Match All

PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).

Show Source

allOf EntityRef

{
    "type":"object",
    "description":"PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).",
    "allOf":[
        {
            "$ref":"#/components/schemas/EntityRef"
        }
    ]
}

Nested Schema : ProductRef

Type: object

A product reference.

Match All

A product reference.

Show Source

object Extensible

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
allOf EntityRef

{
    "type":"object",
    "description":"A product reference.",
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "$ref":"#/components/schemas/EntityRef"
        }
    ]
}

Nested Schema : relatedParty

Type: array

The parties are related to the top-up.

Show Source

Array of: object Related Party

Title: Related Party

A party related to another object.

{
    "type":"array",
    "description":"The parties are related to the top-up.",
    "items":{
        "$ref":"#/components/schemas/RelatedParty"
    }
}

Nested Schema : Related Topup Balance

Type: object

Title: Related Topup Balance

A relationship between balance top-ups that defines whether a balance is the parent or child of another.

Show Source

@baseType: string

Title: Base Type

The object's superclass.
@referredType(required): string

Title: Referred Type

The object's type in the target system, if baseType and type need further disambiguation.
@schemaLocation: string (uri)

Title: Schema Location

A URI to a JSON schema file that defines additional attributes and relationships.
@type: string

Title: Type

The object's subclass.
href: string

Title: Href

The top-up balance's href.
id(required): string

Title: ID

The top-up balance's ID.
name: string

Title: Name

The top-up balance's name.
role: string

Title: Role

The top-up balance's role. For example, parent or child.

{
    "required":[
        "@referredType",
        "id"
    ],
    "type":"object",
    "title":"Related Topup Balance",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The top-up balance's href."
        },
        "id":{
            "type":"string",
            "title":"ID",
            "description":"The top-up  balance's ID."
        },
        "name":{
            "type":"string",
            "title":"Name",
            "description":"The top-up balance's name."
        },
        "role":{
            "type":"string",
            "title":"Role",
            "description":"The top-up balance's role. For example, parent or child."
        }
    },
    "description":"A relationship between balance top-ups that defines whether a balance is the parent or child of another."
}

Nested Schema : Related Party

Type: object

Title: Related Party

A party related to another object.

Show Source

@baseType: string

Title: Base Type

The object's superclass.
@referredType(required): string

Title: Referred Type

The object's type in the target system, if baseType and type need further disambiguation.
@schemaLocation: string (uri)

Title: Schema Location

A URI to a JSON schema file that defines additional attributes and relationships.
@type: string

Title: Type

The object's subclass.
href: string (uri)

Title: Href

The party's href.
id(required): string

Title: Party ID

The party's ID.
name: string

Title: Party Name

The party's name.
role: string

Title: Party Role

The party's role.

{
    "required":[
        "@referredType",
        "id"
    ],
    "type":"object",
    "title":"Related Party",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The party's href.",
            "format":"uri"
        },
        "id":{
            "type":"string",
            "title":"Party ID",
            "description":"The party's ID."
        },
        "name":{
            "type":"string",
            "title":"Party Name",
            "description":"The party's name."
        },
        "role":{
            "type":"string",
            "title":"Party Role",
            "description":"The party's role."
        }
    },
    "description":"A party related to another object."
}

Nested Schema : ImpactedBucket

Type: object

A bucket impacted by a balance top-up, adjustment, transfer, or reservation.

Show Source

@baseType: string

The object's superclass.
@schemaLocation: string (uri)

A URI to a JSON schema file that defines additional attributes and relationships.
@type: string

The object's subclass.
amountAfter: object Quantity

Represents an amount in a specified unit.
amountBefore: object Quantity

Represents an amount in a specified unit.
bucket: object Bucket Ref

Title: Bucket Ref

A reference to a bucket.
confirmationDate: string (date-time)

The date and time the impact was confirmed.
description: string

The impacted bucket's description.
item(required): array item

Minimum Number of Items: 1

The impacted bucket items.
name: string

The impacted bucket's name.
requestedDate: string (date-time)

The date and time the request was received.

{
    "required":[
        "item"
    ],
    "type":"object",
    "properties":{
        "@baseType":{
            "type":"string",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"The object's subclass."
        },
        "amountAfter":{
            "description":"The amount in the bucket after the impact.",
            "$ref":"#/components/schemas/Quantity"
        },
        "amountBefore":{
            "description":"The amount in the bucket before the impact.",
            "$ref":"#/components/schemas/Quantity"
        },
        "bucket":{
            "description":"A reference to the impacted bucket.",
            "$ref":"#/components/schemas/BucketRef"
        },
        "confirmationDate":{
            "type":"string",
            "description":"The date and time the impact was confirmed.",
            "format":"date-time"
        },
        "description":{
            "type":"string",
            "description":"The impacted bucket's description."
        },
        "item":{
            "minItems":1,
            "type":"array",
            "description":"The impacted bucket items.",
            "items":{
                "$ref":"#/components/schemas/ImpactedBucketItem"
            }
        },
        "name":{
            "type":"string",
            "description":"The impacted bucket's name."
        },
        "requestedDate":{
            "type":"string",
            "description":"The date and time the request was received.",
            "format":"date-time"
        }
    },
    "description":"A bucket impacted by a balance top-up, adjustment, transfer, or reservation."
}

Nested Schema : item

Type: array

Minimum Number of Items: 1

The impacted bucket items.

Show Source

Array of: object ImpactedBucketItem

An impact item that affects an ImpactedBucket object.

{
    "minItems":1,
    "type":"array",
    "description":"The impacted bucket items.",
    "items":{
        "$ref":"#/components/schemas/ImpactedBucketItem"
    }
}

Nested Schema : ImpactedBucketItem

Type: object

An impact item that affects an ImpactedBucket object.

Show Source

@baseType: string

The object's superclass.
@schemaLocation: string (uri)

A URI to a JSON schema file that defines additional attributes and relationships.
@type: string

The object's subclass.
amount: object Quantity

Represents an amount in a specified unit.
description: string

The impact item's description.
itemType: string

The impact item's type, indicating if the bucket is incremented (credit) or decremented (debit).
name: string

The impact item's name indicates the transaction activity, such as a top-up or bonus. additional bonus, tax, or fees.
reason: string

The reason for the impact item.

{
    "type":"object",
    "properties":{
        "@baseType":{
            "type":"string",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"The object's subclass."
        },
        "amount":{
            "description":"The impact item's amount.",
            "$ref":"#/components/schemas/Quantity"
        },
        "description":{
            "type":"string",
            "description":"The impact item's description."
        },
        "itemType":{
            "type":"string",
            "description":"The impact item's type, indicating if the bucket is incremented (<b>credit</b>) or decremented (<b>debit</b>)."
        },
        "name":{
            "type":"string",
            "description":"The impact item's name indicates the transaction activity, such as a top-up or bonus. additional bonus, tax, or fees."
        },
        "reason":{
            "type":"string",
            "description":"The reason for the impact item."
        }
    },
    "description":"An impact item that affects an ImpactedBucket object."
}

Nested Schema : EntityRef

Match All

Represents an entity reference schema for EntityRef classes.

Show Source

object Extensible

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
object Addressable

Defines a base schema for addressable entities.
object EntityRef-allOf[2]

Represents an entity reference schema for EntityRef classes.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "$ref":"#/components/schemas/Addressable"
        },
        {
            "type":"object",
            "description":"Represents an entity reference schema for EntityRef classes.",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The identifier of the referred entity."
                },
                "href":{
                    "type":"string",
                    "nullable":true,
                    "description":"The URI of the referred entity."
                },
                "name":{
                    "type":"string",
                    "nullable":true,
                    "description":"The referred entity's name."
                },
                "@referredType":{
                    "type":"string",
                    "nullable":true,
                    "description":"The actual type of the target instance when needed for disambiguation."
                }
            },
            "required":[
                "id"
            ]
        }
    ]
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

@baseType: string

The superclass.
@schemaLocation: string

The URI of a JSON Schema file that defines additional attributes and relationships.
@type(required): string

The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Addressable

Type: object

Defines a base schema for addressable entities.

Show Source

href: string

The hyperlink reference.
id: string

The ID.

{
    "type":"object",
    "description":"Defines a base schema for addressable entities.",
    "properties":{
        "href":{
            "type":"string",
            "nullable":true,
            "description":"The hyperlink reference."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        }
    }
}

Nested Schema : EntityRef-allOf[2]

Type: object

Represents an entity reference schema for EntityRef classes.

Show Source

@referredType: string

The actual type of the target instance when needed for disambiguation.
href: string

The URI of the referred entity.
id(required): string

The identifier of the referred entity.
name: string

The referred entity's name.

{
    "type":"object",
    "description":"Represents an entity reference schema for EntityRef classes.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The identifier of the referred entity."
        },
        "href":{
            "type":"string",
            "nullable":true,
            "description":"The URI of the referred entity."
        },
        "name":{
            "type":"string",
            "nullable":true,
            "description":"The referred entity's name."
        },
        "@referredType":{
            "type":"string",
            "nullable":true,
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "required":[
        "id"
    ]
}

400 Response

The request isn't valid.

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

object Extensible

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

@baseType: string

The superclass.
@schemaLocation: string

The URI of a JSON Schema file that defines additional attributes and relationships.
@type(required): string

The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

code(required): string

The application-specific error detail defined by the API or a common list.
message: string

Provides error details and corrective actions for a client user.
reason(required): string

Explains the error to a client user.
referenceError: string

The URI of documentation that describes the error.
status: string

The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

401 Response

The client doesn't have the correct privileges.

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

object Extensible

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

@baseType: string

The superclass.
@schemaLocation: string

The URI of a JSON Schema file that defines additional attributes and relationships.
@type(required): string

The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

code(required): string

The application-specific error detail defined by the API or a common list.
message: string

Provides error details and corrective actions for a client user.
reason(required): string

Explains the error to a client user.
referenceError: string

The URI of documentation that describes the error.
status: string

The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

403 Response

The request wasn't authorized.

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

object Extensible

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

@baseType: string

The superclass.
@schemaLocation: string

The URI of a JSON Schema file that defines additional attributes and relationships.
@type(required): string

The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

code(required): string

The application-specific error detail defined by the API or a common list.
message: string

Provides error details and corrective actions for a client user.
reason(required): string

Explains the error to a client user.
referenceError: string

The URI of documentation that describes the error.
status: string

The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

404 Response

The requested resource couldn't be found.

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

object Extensible

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

@baseType: string

The superclass.
@schemaLocation: string

The URI of a JSON Schema file that defines additional attributes and relationships.
@type(required): string

The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

code(required): string

The application-specific error detail defined by the API or a common list.
message: string

Provides error details and corrective actions for a client user.
reason(required): string

Explains the error to a client user.
referenceError: string

The URI of documentation that describes the error.
status: string

The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

405 Response

This method is not allowed.

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

object Extensible

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

@baseType: string

The superclass.
@schemaLocation: string

The URI of a JSON Schema file that defines additional attributes and relationships.
@type(required): string

The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

code(required): string

The application-specific error detail defined by the API or a common list.
message: string

Provides error details and corrective actions for a client user.
reason(required): string

Explains the error to a client user.
referenceError: string

The URI of documentation that describes the error.
status: string

The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

409 Response

The request could not be processed due to the conflict with the existing state of the resource.

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

object Extensible

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

@baseType: string

The superclass.
@schemaLocation: string

The URI of a JSON Schema file that defines additional attributes and relationships.
@type(required): string

The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

code(required): string

The application-specific error detail defined by the API or a common list.
message: string

Provides error details and corrective actions for a client user.
reason(required): string

Explains the error to a client user.
referenceError: string

The URI of documentation that describes the error.
status: string

The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

500 Response

The system encountered an internal error.

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

object Extensible

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

@baseType: string

The superclass.
@schemaLocation: string

The URI of a JSON Schema file that defines additional attributes and relationships.
@type(required): string

The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

code(required): string

The application-specific error detail defined by the API or a common list.
message: string

Provides error details and corrective actions for a client user.
reason(required): string

Explains the error to a client user.
referenceError: string

The URI of documentation that describes the error.
status: string

The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

Examples

The following example shows how to get top-up balances by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

The request uses query parameters to show two top-up balances for a specified account.

curl -X GET 'http://host:port/brm/prepayBalanceManagement/version/topupBalance?partyAccount.id=0.0.0.1+-account+6340627&limit=2'

Response Body

The following example shows the contents of the response body in JSON format.

[
   {
      "@baseType": "TopupBalance",
      "@schemaLocation": null,
      "@type": "TopupBalance",
      "amount": {
         "amount": 2.0,
         "units": "USD",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": null
      },
      "bucket": {
         "id": "0.0.0.1+-balance_group+6344211+840+0",
         "href": "http://host:port/brm/prepayBalanceManagement/v4/bucket/0.0.0.1+-balance_group+6344211+840+0",
         "name": null,
         "@baseType": "BucketRef",
         "@schemaLocation": null,
         "@type": "BucketRef",
         "@referredType": null
      },
      "channel": null,
      "confirmationDate": "2025-09-20T11:45:02+05:30",
      "description": null,
      "href": "http://host:port/brm/prepayBalanceManagement/v4/topupBalance/0.0.0.1+-topup+6448982",
      "id": "0.0.0.1+-topup+6448982",
      "impactedBucket": [
         {
            "@baseType": "ImpactedBucket",
            "@schemaLocation": null,
            "@type": "ImpactedBucket",
            "amountAfter": {
               "amount": -2.0,
               "units": "USD",
               "@baseType": null,
               "@schemaLocation": null,
               "@type": null
            },
            "amountBefore": {
               "amount": 0.0,
               "units": "USD",
               "@baseType": null,
               "@schemaLocation": null,
               "@type": null
            },
            "bucket": {
               "id": "0.0.0.1+-balance_group+6344211+840+0",
               "href": "http://host:port/brm/prepayBalanceManagement/v4/bucket/0.0.0.1+-balance_group+6344211+840+0",
               "name": null,
               "@baseType": "BucketRef",
               "@schemaLocation": null,
               "@type": "BucketRef",
               "@referredType": null
            },
            "confirmationDate": null,
            "description": null,
            "item": [
               {
                  "@baseType": "ImpactedBucketItem",
                  "@schemaLocation": null,
                  "@type": "ImpactedBucketItem",
                  "amount": {
                     "amount": 2.0,
                     "units": "USD",
                     "@baseType": null,
                     "@schemaLocation": null,
                     "@type": null
                  },
                  "description": null,
                  "itemType": null,
                  "name": null,
                  "reason": null
               }
            ],
            "name": null,
            "requestedDate": null
         }
      ],
      "isAutoTopup": false,
      "logicalResource": {
         "@baseType": null,
         "@referredType": null,
         "@schemaLocation": null,
         "@type": null,
         "href": null,
         "id": null,
         "name": null,
         "value": ""
      },
      "numberOfPeriods": null,
      "partyAccount": {
         "id": "0.0.0.1+-account+6340627",
         "href": null,
         "description": null,
         "name": "Jane Mason",
         "status": "active",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": "PartyAccountRef",
         "@referredType": null
      },
      "payment": {
         "id": "0.0.0.1+-item-payment+6450518",
         "href": "http://host:port/brm/payment/v4/payment/0.0.0.1+-item-payment+6450518",
         "name": "Billing Event Log",
         "amount": {
            "unit": "USD",
            "value": 2.0
         },
         "paymentDate": "2025-09-20T11:45:01+05:30",
         "@baseType": "Payment",
         "@schemaLocation": null,
         "@type": "Payment",
         "@referredType": null
      },
      "paymentMethod": {
         "id": "0.0.0.1+-payinfo-cc+6342675",
         "href": "http:/host:port/brm/paymentMethods/v1/paymentMethod/0.0.0.1+-payinfo-cc+6342675",
         "description": null,
         "isPreferred": true,
         "name": "PIN Payinfo Object",
         "status": null,
         "statusDate": null,
         "account": [
            {
               "id": "0.0.0.1+-account+6340627",
               "href": null,
               "description": null,
               "name": "Jane Mason",
               "@baseType": null,
               "@schemaLocation": null,
               "@type": null,
               "@referredType": null
            }
         ],
         "relatedParty": null,
         "validFor": null,
         "@baseType": null,
         "@schemaLocation": null,
         "@type": "tokenizedCard",
         "@referredType": null
      },
      "product": {
         "id": "0.0.0.1+-service-telco-gsm-telephony+6343955",
         "href": null,
         "name": "ServiceTelcoGsmTelephony",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": "ProductRef",
         "@referredType": null
      },
      "reason": null,
      "recurringPeriod": null,
      "relatedParty": null,
      "relatedTopupBalance": null,
      "requestedDate": "2025-09-20T11:45:02+05:30",
      "requestor": null,
      "status": "CONFIRMED",
      "usageType": "monetary",
      "voucher": ""
   },
   {
      "@baseType": "TopupBalance",
      "@schemaLocation": null,
      "@type": "TopupBalance",
      "amount": {
         "amount": 20.0,
         "units": "USD",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": null
      },
      "bucket": {
         "id": "0.0.0.1+-balance_group+4097444+840+0",
         "href": "http://host:port/brm/prepayBalanceManagement/v4/bucket/0.0.0.1+-balance_group+4097444+840+0",
         "name": null,
         "@baseType": "BucketRef",
         "@schemaLocation": null,
         "@type": "BucketRef",
         "@referredType": null
      },
      "channel": null,
      "confirmationDate": "2025-09-20T10:41:44+05:30",
      "description": null,
      "href": "http://host:port/brm/prepayBalanceManagement/v4/topupBalance/0.0.0.1+-topup+6442543",
      "id": "0.0.0.1+-topup+6442543",
      "impactedBucket": [
         {
            "@baseType": "ImpactedBucket",
            "@schemaLocation": null,
            "@type": "ImpactedBucket",
            "amountAfter": {
               "amount": 643.0,
               "units": "USD",
               "@baseType": null,
               "@schemaLocation": null,
               "@type": null
            },
            "amountBefore": {
               "amount": 663.0,
               "units": "USD",
               "@baseType": null,
               "@schemaLocation": null,
               "@type": null
            },
            "bucket": {
               "id": "0.0.0.1+-balance_group+4097444+840+0",
               "href": "http://host:port/brm/prepayBalanceManagement/v4/bucket/0.0.0.1+-balance_group+4097444+840+0",
               "name": null,
               "@baseType": "BucketRef",
               "@schemaLocation": null,
               "@type": "BucketRef",
               "@referredType": null
            },
            "confirmationDate": null,
            "description": null,
            "item": [
               {
                  "@baseType": "ImpactedBucketItem",
                  "@schemaLocation": null,
                  "@type": "ImpactedBucketItem",
                  "amount": {
                     "amount": 20.0,
                     "units": "USD",
                     "@baseType": null,
                     "@schemaLocation": null,
                     "@type": null
                  },
                  "description": null,
                  "itemType": null,
                  "name": null,
                  "reason": null
               }
            ],
            "name": null,
            "requestedDate": null
         }
      ],
      "isAutoTopup": false,
      "logicalResource": {
         "@baseType": null,
         "@referredType": null,
         "@schemaLocation": null,
         "@type": null,
         "href": null,
         "id": null,
         "name": null,
         "value": "056-20250812-035011-1-20412--146856192-cagbu-phx-175"
      },
      "numberOfPeriods": null,
      "partyAccount": {
         "id": "0.0.0.1+-account+6340627",
         "href": null,
         "description": null,
         "name": "Jane Mason",
         "status": "active",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": "PartyAccountRef",
         "@referredType": null
      },
      "payment": {
         "id": "0.0.0.1+-item-payment+6439471",
         "href": "http://host:port/brm/payment/v4/payment/0.0.0.1+-item-payment+6439471",
         "name": "Billing Event Log",
         "amount": {
            "unit": "USD",
            "value": 20.0
         },
         "paymentDate": "2025-09-20T10:41:43+05:30",
         "@baseType": "Payment",
         "@schemaLocation": null,
         "@type": "Payment",
         "@referredType": null
      },
      "paymentMethod": {
         "id": "0.0.0.1+-payinfo-cc+6306114",
         "href": "http://host:port/brm/paymentMethods/v1/paymentMethod/0.0.0.1+-payinfo-cc+6306114",
         "description": null,
         "isPreferred": false,
         "name": "PIN Payinfo Object",
         "status": null,
         "statusDate": null,
         "account": [
            {
               "id": "0.0.0.1+-account+6340627",
               "href": null,
               "description": null,
               "name": "Jane Mason",
               "@baseType": null,
               "@schemaLocation": null,
               "@type": null,
               "@referredType": null
            }
         ],
         "relatedParty": null,
         "validFor": null,
         "@baseType": null,
         "@schemaLocation": null,
         "@type": "tokenizedCard",
         "@referredType": null
      },
      "product": {
         "id": "0.0.0.1+-service-telco-gsm-sms+4099940",
         "href": null,
         "name": "ServiceTelcoGsmSms",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": "ProductRef",
         "@referredType": null
      },
      "reason": null,
      "recurringPeriod": null,
      "relatedParty": null,
      "relatedTopupBalance": null,
      "requestedDate": "2025-09-20T10:41:44+05:30",
      "requestor": null,
      "status": "CONFIRMED",
      "usageType": "monetary",
      "voucher": ""
   }
]