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.
Back to TopResponse
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
object
Quantity
Title:
Quantity
The quantity of an object. -
bucket: object
object
Bucket Ref
Title:
Bucket Ref
A reference to a bucket. -
channel: object
object
ChannelRef
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
array
impactedBucket
Buckets impacted by the request.
-
logicalResource: object
object
Logical Resource Ref
Title:
Logical Resource Ref
A reference to a logical resource. -
partyAccount: object
object
Party Account Ref
Title:
Party Account Ref
A reference to a party account. -
product: object
object
Product Ref
Title:
Product Ref
A reference to a product. -
reason: string
The reason for the action.
- relatedParty: array array relatedParty
-
requestedDate: string
(date-time)
The date that the request for the action was made.
-
requestor: object
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.
Nested Schema : Quantity
Type:
object
Title:
Quantity
The quantity of an object.
Show Source
-
amount: number
(float)
Title:
Amount
Default Value:1
A numeric value. -
units: string
Title:
Units
A unit. For example, MB or minutes.
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.
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.
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.
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 resource's value.
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.
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.
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.
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
object
Quantity
Title:
Quantity
The quantity of an object. -
amountBefore: object
object
Quantity
Title:
Quantity
The quantity of an object. -
bucket: object
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
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.
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.
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
object
Quantity
Title:
Quantity
The quantity of an object. -
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.
400 Response
Bad Request
Root Schema : Error
Type:
object
Title:
Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
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. -
code(required): string
Title:
Error Code
An error code. -
message: string
Title:
Error Message
Details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension.
401 Response
Unauthorized
Root Schema : Error
Type:
object
Title:
Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
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. -
code(required): string
Title:
Error Code
An error code. -
message: string
Title:
Error Message
Details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension.
403 Response
Forbidden
Root Schema : Error
Type:
object
Title:
Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
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. -
code(required): string
Title:
Error Code
An error code. -
message: string
Title:
Error Message
Details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension.
404 Response
Not Found
Root Schema : Error
Type:
object
Title:
Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
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. -
code(required): string
Title:
Error Code
An error code. -
message: string
Title:
Error Message
Details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension.
405 Response
Method Not Allowed
Root Schema : Error
Type:
object
Title:
Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
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. -
code(required): string
Title:
Error Code
An error code. -
message: string
Title:
Error Message
Details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension.
409 Response
Conflict
Root Schema : Error
Type:
object
Title:
Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
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. -
code(required): string
Title:
Error Code
An error code. -
message: string
Title:
Error Message
Details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension.
500 Response
Internal Server Error
Root Schema : Error
Type:
object
Title:
Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
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. -
code(required): string
Title:
Error Code
An error code. -
message: string
Title:
Error Message
Details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension.
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" }