REST Services Manager API for Billing and Revenue Management

Get a Balance Action by ID

get

/balanceAction/{id}

Gets the specified balance action.

Request

Path Parameters

id(required): string
The ID of the balance action to get.
Example:
```
0.0.0.1+-event-audit-transfer_balance+3213212
```

Query Parameters

@type(required): string
The type of object to return. Can be one of the following: TransferBalance, TopupBalance, AdjustBalance, or AdjustBalanceOracle for an extended object.
Example:
```
TransferBalance
```
fields: string
The list of comma-separated fields to return in the response.
Example:
```
impactedBucket,usageType
```

There's no request body for this operation.

Response

Supported Media Types

application/json;charset=utf-8

200 Response

Success

Root Schema : BalanceAction

Type: object

An abstract resource for an action, such as adjusting or topping up a balance.

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(required): string

The object's subclass.
amount: object Quantity

An amount in a given unit.
bucket: object Bucket Ref

Title: Bucket Ref

A reference to a bucket.
channel: object Channel Ref

Title: Channel Ref

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

The date that the action was confirmed.
description: string

The action's description.
href: string

The action's href.
id: string

The action's ID.
impactedBucket: array impactedBucket

Buckets impacted by the request.
logicalResource: object Logical Resource Ref

Title: Logical Resource Ref

A reference to a logical resource.
partyAccount: object Party Account Ref

Title: Party Account Ref

A reference to a party account.
product: object Product Ref

Title: Product Ref

A reference to a product.
reason: string

The reason for the action.
relatedParty: array relatedParty

Parties related to the action. to the operation
requestedDate: string (date-time)

The date that the request for the action was made.
requestor: object Related Party

Title: Related Party

A party related to another object.
status: string

The request's status.
usageType: string

The action's usage type.

{
    "required":[
        "@type"
    ],
    "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 amount associated with the action.",
            "$ref":"#/components/schemas/Quantity"
        },
        "bucket":{
            "description":"The bucket associated with the action.",
            "$ref":"#/components/schemas/BucketRef"
        },
        "channel":{
            "description":"The channel associated with the action.",
            "$ref":"#/components/schemas/ChannelRef"
        },
        "confirmationDate":{
            "type":"string",
            "description":"The date that the action was confirmed.",
            "format":"date-time"
        },
        "description":{
            "type":"string",
            "description":"The action's description."
        },
        "href":{
            "type":"string",
            "description":"The action's href."
        },
        "id":{
            "type":"string",
            "description":"The action's ID."
        },
        "impactedBucket":{
            "type":"array",
            "description":"Buckets impacted by the request.",
            "items":{
                "$ref":"#/components/schemas/ImpactedBucket"
            }
        },
        "logicalResource":{
            "description":"A logical resource associated with the action.",
            "$ref":"#/components/schemas/LogicalResourceRef"
        },
        "partyAccount":{
            "description":"A party account associated with the action.",
            "$ref":"#/components/schemas/PartyAccountRef"
        },
        "product":{
            "description":"A product associated with the action.",
            "$ref":"#/components/schemas/ProductRef"
        },
        "reason":{
            "type":"string",
            "description":"The reason for the action."
        },
        "relatedParty":{
            "type":"array",
            "description":"Parties related to the action. to the operation",
            "items":{
                "$ref":"#/components/schemas/RelatedParty"
            }
        },
        "requestedDate":{
            "type":"string",
            "description":"The date that the request for the action was made.",
            "format":"date-time"
        },
        "requestor":{
            "description":"The party that requested the action.",
            "$ref":"#/components/schemas/RelatedParty"
        },
        "status":{
            "type":"string",
            "description":"The request's status."
        },
        "usageType":{
            "type":"string",
            "description":"The action's usage type."
        }
    },
    "description":"An abstract resource for an action, such as adjusting or topping up a balance. "
}

Nested Schema : Quantity

Type: object

An amount in a given unit.

Show Source

amount: number (float)

Default Value: 1

Numeric value in a given unit.
units: string

Unit

{
    "type":"object",
    "description":"An amount in a given unit.",
    "properties":{
        "amount":{
            "default":1,
            "type":"number",
            "format":"float",
            "description":"Numeric value in a given unit."
        },
        "units":{
            "type":"string",
            "description":"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

Title: Bucket Href

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

Title: Bucket ID

The bucket's ID.
name: string

Title: Bucket Name

The bucket's name.

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Bucket Ref",
    "properties":{
        "id":{
            "type":"string",
            "title":"Bucket ID",
            "description":"The bucket's ID."
        },
        "href":{
            "type":"string",
            "title":"Bucket Href",
            "description":"The bucket's href."
        },
        "name":{
            "type":"string",
            "title":"Bucket Name",
            "description":"The bucket'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 bucket."
}

Nested Schema : Channel Ref

Type: object

Title: Channel Ref

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",
    "title":"Channel Ref",
    "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

Buckets 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":"Buckets 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.

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Logical Resource Ref",
    "properties":{
        "id":{
            "type":"string",
            "title":"ID",
            "description":"The resource's ID."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The resource's href."
        },
        "name":{
            "type":"string",
            "title":"Name",
            "description":"The resource'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 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":{
        "id":{
            "type":"string",
            "title":"Account ID",
            "description":"The party account's ID."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The party account's href."
        },
        "description":{
            "type":"string",
            "title":"Description",
            "description":"The party account's description."
        },
        "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, <b>due</b>, <b>paid</b>, or <b>in arrears</b>."
        },
        "@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 party account."
}

Nested Schema : Product Ref

Type: object

Title: Product Ref

A reference to a product.

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: Product Href

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

Title: Product ID

The product's ID.
name: string

Title: Product Name

The product's name.

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Product Ref",
    "description":"A reference to a product.",
    "properties":{
        "id":{
            "type":"string",
            "title":"Product ID",
            "description":"The product's ID."
        },
        "href":{
            "type":"string",
            "title":"Product Href",
            "description":"The product's href."
        },
        "name":{
            "type":"string",
            "title":"Product Name",
            "description":"The product'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."
        }
    }
}

Nested Schema : relatedParty

Type: array

Parties related to the action. to the operation

Show Source

Array of: object Related Party

Title: Related Party

A party related to another object.

{
    "type":"array",
    "description":"Parties related to the action. to the operation",
    "items":{
        "$ref":"#/components/schemas/RelatedParty"
    }
}

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

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":{
        "id":{
            "type":"string",
            "title":"Party ID",
            "description":"The party's ID."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The party's href."
        },
        "name":{
            "type":"string",
            "title":"Party Name",
            "description":"The party's name."
        },
        "role":{
            "type":"string",
            "title":"Party Role",
            "description":"The party's role."
        },
        "@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 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

An amount in a given unit.
amountBefore: object Quantity

An amount in a given unit.
bucket: object Bucket Ref

Title: Bucket Ref

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

The date 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 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 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 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

An amount in a given 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, indicating the transaction activity. For example, top-up, 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 (credit) or decremented (debit)."
        },
        "name":{
            "type":"string",
            "description":"The impact item's name, indicating the transaction activity. For example, top-up, 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."
}

400 Response

Bad Request

Root Schema : Error

Type: object

This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@baseType: string

This defines the super-class when sub-classing.
@schemaLocation: string (uri)

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

This defines the sub-class entity name when sub-classing.
code(required): string

Refers to application relevant detail, defined in the API or a common list.
message: string

More details and corrective actions related to the error which can be shown to a client user.
reason(required): string

Explanation of the reason for the error which can be shown to a client user.
referenceError: string (uri)

URI of documentation describing the error.
status: string

Displays the HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Refers to application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"Displays the HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"This defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"This defines the sub-class entity name when sub-classing."
        }
    },
    "description":"This is used when an API throws an error, typically with a HTTP error response-code (<b>3xx, 4xx, 5xx</b>)."
}

401 Response

Unauthorized

Root Schema : Error

Type: object

This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@baseType: string

This defines the super-class when sub-classing.
@schemaLocation: string (uri)

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

This defines the sub-class entity name when sub-classing.
code(required): string

Refers to application relevant detail, defined in the API or a common list.
message: string

More details and corrective actions related to the error which can be shown to a client user.
reason(required): string

Explanation of the reason for the error which can be shown to a client user.
referenceError: string (uri)

URI of documentation describing the error.
status: string

Displays the HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Refers to application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"Displays the HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"This defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"This defines the sub-class entity name when sub-classing."
        }
    },
    "description":"This is used when an API throws an error, typically with a HTTP error response-code (<b>3xx, 4xx, 5xx</b>)."
}

403 Response

Forbidden

Root Schema : Error

Type: object

This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@baseType: string

This defines the super-class when sub-classing.
@schemaLocation: string (uri)

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

This defines the sub-class entity name when sub-classing.
code(required): string

Refers to application relevant detail, defined in the API or a common list.
message: string

More details and corrective actions related to the error which can be shown to a client user.
reason(required): string

Explanation of the reason for the error which can be shown to a client user.
referenceError: string (uri)

URI of documentation describing the error.
status: string

Displays the HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Refers to application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"Displays the HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"This defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"This defines the sub-class entity name when sub-classing."
        }
    },
    "description":"This is used when an API throws an error, typically with a HTTP error response-code (<b>3xx, 4xx, 5xx</b>)."
}

404 Response

Not Found

Root Schema : Error

Type: object

This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@baseType: string

This defines the super-class when sub-classing.
@schemaLocation: string (uri)

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

This defines the sub-class entity name when sub-classing.
code(required): string

Refers to application relevant detail, defined in the API or a common list.
message: string

More details and corrective actions related to the error which can be shown to a client user.
reason(required): string

Explanation of the reason for the error which can be shown to a client user.
referenceError: string (uri)

URI of documentation describing the error.
status: string

Displays the HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Refers to application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"Displays the HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"This defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"This defines the sub-class entity name when sub-classing."
        }
    },
    "description":"This is used when an API throws an error, typically with a HTTP error response-code (<b>3xx, 4xx, 5xx</b>)."
}

405 Response

Method Not Allowed

Root Schema : Error

Type: object

This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@baseType: string

This defines the super-class when sub-classing.
@schemaLocation: string (uri)

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

This defines the sub-class entity name when sub-classing.
code(required): string

Refers to application relevant detail, defined in the API or a common list.
message: string

More details and corrective actions related to the error which can be shown to a client user.
reason(required): string

Explanation of the reason for the error which can be shown to a client user.
referenceError: string (uri)

URI of documentation describing the error.
status: string

Displays the HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Refers to application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"Displays the HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"This defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"This defines the sub-class entity name when sub-classing."
        }
    },
    "description":"This is used when an API throws an error, typically with a HTTP error response-code (<b>3xx, 4xx, 5xx</b>)."
}

409 Response

Conflict

Root Schema : Error

Type: object

This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@baseType: string

This defines the super-class when sub-classing.
@schemaLocation: string (uri)

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

This defines the sub-class entity name when sub-classing.
code(required): string

Refers to application relevant detail, defined in the API or a common list.
message: string

More details and corrective actions related to the error which can be shown to a client user.
reason(required): string

Explanation of the reason for the error which can be shown to a client user.
referenceError: string (uri)

URI of documentation describing the error.
status: string

Displays the HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Refers to application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"Displays the HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"This defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"This defines the sub-class entity name when sub-classing."
        }
    },
    "description":"This is used when an API throws an error, typically with a HTTP error response-code (<b>3xx, 4xx, 5xx</b>)."
}

500 Response

Internal Server Error

Root Schema : Error

Type: object

This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@baseType: string

This defines the super-class when sub-classing.
@schemaLocation: string (uri)

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

This defines the sub-class entity name when sub-classing.
code(required): string

Refers to application relevant detail, defined in the API or a common list.
message: string

More details and corrective actions related to the error which can be shown to a client user.
reason(required): string

Explanation of the reason for the error which can be shown to a client user.
referenceError: string (uri)

URI of documentation describing the error.
status: string

Displays the HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Refers to application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"Displays the HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"This defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"This defines the sub-class entity name when sub-classing."
        }
    },
    "description":"This is used when an API throws an error, typically with a HTTP error response-code (<b>3xx, 4xx, 5xx</b>)."
}

Examples

The following example shows how to get a specific balance action by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET 'http://host:port/brm/prepayBalanceManagement/version/balanceAction/0.0.0.1+-event-audit-transfer_balance+321321278103898458?@type=TransferBalance'

Example of the Response Body

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

{
              "@baseType": "TransferBalance",
              "@schemaLocation": null,
              "@type": "TransferBalance",
              "amount": {
                     "amount": 4,
                     "units": "USD",
                     "@baseType": "Quantity",
                     "@schemaLocation": null,
                     "@type": "Quantity"
              },
              "bucket": {
                     "id": "0.0.0.1+-balance_group+292953+840+12",
                     "href": "http://host:port/brm/prepayBalanceManagement/v4/bucket/0.0.0.1+-balance_group+292953+840+12",
                     "name": null,
                     "@baseType": "BucketRef",
                     "@schemaLocation": null,
                     "@type": "BucketRef",
                     "@referredType": null
              },
              "channel": null,
              "confirmationDate": "2020-01-04T23:54:35+05:30",
              "costOwner": "originator",
              "description": "",
              "href": "http://host:port/brm/prepayBalanceManagement/v4/transferBalance/0.0.0.1+-event-audit-transfer_balance+321321278103898458",
              "id": "0.0.0.1+-event-audit-transfer_balance+321321278103898458",
              "impactedBucket": [
                     {
                            "@baseType": "ImpactedBucket",
                            "@schemaLocation": null,
                            "@type": "ImpactedBucket",
                            "amountAfter": null,
                            "amountBefore": null,
                            "bucket": {
                                   "id": "0.0.0.1+-balance_group+292953+840+12",
                                   "href": "http://host:port/brm/prepayBalanceManagement/v4/bucket/0.0.0.1+-balance_group+292953+840+12",
                                   "name": null,
                                   "@baseType": "BucketRef",
                                   "@schemaLocation": null,
                                   "@type": "BucketRef",
                                   "@referredType": null
                            },
                            "confirmationDate": "2020-01-04T23:54:35+05:30",
                            "description": null,
                            "item": [
                                   {
                                          "@baseType": "ImpactedBucketItem",
                                          "@schemaLocation": null,
                                          "@type": "ImpactedBucketItem",
                                          "amount": {
                                                 "amount": 2,
                                                 "units": "USD",
                                                 "@baseType": "Quantity",
                                                 "@schemaLocation": null,
                                                 "@type": "Quantity"
                                          },
                                          "description": null,
                                          "itemType": "debit",
                                          "name": "transfer cost-originator",
                                          "reason": null
                                   }
                            ],
                            "name": null,
                            "requestedDate": "2020-01-04T23:54:35+05:30"
                     }
              ],
              "logicalResource": {
                     "@baseType": "LogicalResourceRef",
                     "@referredType": null,
                     "@schemaLocation": null,
                     "@type": "LogicalResourceRef",
                     "href": null,
                     "id": null,
                     "name": null,
                     "value": "298-20210315-061509-2-93999--155732224-den00qny"
              },
              "partyAccount": {
                     "id": "0.0.0.1+-account+293273",
                     "href": null,
                     "description": null,
                     "name": "Paul Octavo",
                     "status": "active",
                     "@baseType": "PartyAccountRef",
                     "@schemaLocation": null,
                     "@type": "PartyAccountRef",
                     "@referredType": null
              },
              "product": {
                     "id": "0.0.0.1+-service-telco-gsm-telephony+292441",
                     "href": null,
                     "name": "ServiceTelcoGsmTelephony",
                     "@baseType": "ProductRef",
                     "@schemaLocation": null,
                     "@type": "ProductRef",
                     "@referredType": null
              },
              "reason": null,
              "receiver": null,
              "receiverBucket": {
                     "id": "0.0.0.1+-balance_group+293048+840+8",
                     "href": "http://host:port/brm/prepayBalanceManagement/v4/bucket/0.0.0.1+-balance_group+293048+840+8",
                     "name": null,
                     "@baseType": "BucketRef",
                     "@schemaLocation": null,
                     "@type": "BucketRef",
                     "@referredType": null
              },
              "receiverBucketUsageType": null,
              "receiverLogicalResource": {
                     "@baseType": "LogicalResourceRef",
                     "@referredType": null,
                     "@schemaLocation": null,
                     "@type": "LogicalResourceRef",
                     "href": null,
                     "id": null,
                     "name": null,
                     "value": "007-20210315-061430-0-93999--155732224-den00qny"
              },
              "receiverPartyAccount": {
                     "id": "0.0.0.1+-account+293176",
                     "href": null,
                     "description": null,
                     "name": "Jane Sinclair",
                     "status": "active",
                     "@baseType": "PartyAccountRef",
                     "@schemaLocation": null,
                     "@type": "PartyAccountRef",
                     "@referredType": null
              },
              "receiverProduct": {
                     "id": "0.0.0.1+-service-telco-gsm-telephony+292536",
                     "href": null,
                     "name": "ServiceTelcoGsmTelephony",
                     "@baseType": "ProductRef",
                     "@schemaLocation": null,
                     "@type": "ProductRef",
                     "@referredType": null
              },
              "relatedParty": null,
              "requestedDate": "2020-01-04T23:54:35+05:30",
              "requestor": null,
              "status": "CONFIRMED",
              "transferCost": {
                     "amount": 2,
                     "units": "USD",
                     "@baseType": "Quantity",
                     "@schemaLocation": null,
                     "@type": "Quantity"
              },
              "usageType": "monetary"
}