Get a Transfer Balance by ID
get
/transferBalance/{id}
Gets the specified transfer balance.
Request
Path Parameters
-
id(required): string
The ID of the transfer balance to get.
Query Parameters
-
fields: string
The list of comma-separated fields to return in the response.Example:
requestor,requestedDate
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json;charset=utf-8
200 Response
Success
Root Schema : Transfer Balance
Type:
objectTitle:
Transfer BalanceA balance being transferred between buckets.
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON-Schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
amount: object
Quantity
An amount in a given unit.
-
bucket: object
Bucket Ref
Title:
Bucket RefA reference to a bucket. -
channel(required): object
Channel Ref
Title:
Channel RefA reference to a channel. -
confirmationDate: string
(date-time)
Title:
Confirmation DateThe date the transfer was confirmed. -
costOwner: string
Title:
Cost OwnerTypeAllowed Values:[ "originator", "receiver" ]The type of cost owner. -
description: string
Title:
DescriptionThe transfer's description. -
href(required): string
Title:
HrefThe transferred balance's href. -
id(required): string
Title:
IDThe transferred balance's ID. -
logicalResource(required): array
logicalResource
Minimum Number of Items:
1Logical resources associated with the transfer. -
partyAccount: object
Party Account Ref
Title:
Party Account RefA reference to a party account. -
product: array
product
Products associated with the transfer.
-
reason(required): string
Title:
ReasonThe reason for the transfer. -
receiver: object
Related Party
Title:
Related PartyA party related to another object. -
receiverBucket: object
Bucket Ref
Title:
Bucket RefA reference to a bucket. -
receiverBucketUsageType: string
Title:
Usage TypeAllowed Values:[ "monetary", "voice", "data", "sms", "other" ]The type of usage. For BRM REST Services Manager, only monetary and other are supported. -
receiverLogicalResource(required): object
Logical Resource Ref
Title:
Logical Resource RefA reference to a logical resource. -
receiverProduct: object
Product Ref
Title:
Product RefA reference to a product. - relatedParty: array relatedParty
-
requestedDate: string
(date-time)
Title:
Requested DateThe date that the request was received. -
requestor: object
Related Party
Title:
Related PartyA party related to another object. -
status(required): string
Title:
Action Status TypeAllowed Values:[ "created", "failed", "cancelled", "completed" ]The status of an action. -
transferCost: object
Money
A base / value business entity used to represent money.
-
usageType: string
Title:
Usage TypeAllowed Values:[ "monetary", "voice", "data", "sms", "other" ]The type of usage. For BRM REST Services Manager, only monetary and other are supported. -
validFor: object
TimePeriod
A period of time.
Nested Schema : Quantity
Type:
objectAn amount in a given unit.
Show Source
-
amount: number
(float)
Default Value:
1Numeric value in a given unit. -
units: string
Unit
Nested Schema : Bucket Ref
Type:
objectTitle:
Bucket RefA reference to a bucket.
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@referredType: string
Title:
Referred TypeThe object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON-Schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
href: string
Title:
Bucket HrefThe bucket's href. -
id(required): string
Title:
Bucket IDThe bucket's ID. -
name: string
Title:
Bucket NameThe bucket's name.
Nested Schema : Channel Ref
Type:
objectTitle:
Channel RefA reference to a channel.
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@referredType: string
Title:
Referred TypeThe object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON-Schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
href: string
Title:
Channel HrefThe channel's href. -
id(required): string
Title:
Channel IDThe channel's ID. -
name: string
Title:
Channel NameThe channel's name.
Nested Schema : logicalResource
Type:
arrayMinimum Number of Items:
1Logical resources associated with the transfer.
Show Source
-
Array of:
object Logical Resource Ref
Title:
Logical Resource RefA reference to a logical resource.
Nested Schema : Party Account Ref
Type:
objectTitle:
Party Account RefA reference to a party account.
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@referredType: string
Title:
Referred TypeThe object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON-Schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
description: string
Title:
DescriptionThe party account's description. -
href: string
Title:
HrefThe party account's href. -
id(required): string
Title:
Account IDThe party account's ID. -
name: string
Title:
NameThe party account's name. -
status: string
Title:
StatusThe overall status of the account. For example, due, paid, or in arrears.
Nested Schema : product
Type:
arrayProducts associated with the transfer.
Show Source
-
Array of:
object Product Ref
Title:
Product RefA reference to a product.
Nested Schema : Related Party
Type:
objectTitle:
Related PartyA party related to another object.
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@referredType(required): string
Title:
Referred TypeThe object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON-Schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
href: string
Title:
HrefThe party's href. -
id(required): string
Title:
Party IDThe party's ID. -
name: string
Title:
Party NameThe party's name. -
role: string
Title:
Party RoleThe party's role.
Nested Schema : Logical Resource Ref
Type:
objectTitle:
Logical Resource RefA reference to a logical resource.
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@referredType: string
Title:
Referred TypeThe object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON-Schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
href: string
Title:
HrefThe resource's href. -
id(required): string
Title:
IDThe resource's ID. -
name: string
Title:
NameThe resource's name.
Nested Schema : Product Ref
Type:
objectTitle:
Product RefA reference to a product.
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@referredType: string
Title:
Referred TypeThe object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON-Schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
href: string
Title:
Product HrefThe product's href. -
id(required): string
Title:
Product IDThe product's ID. -
name: string
Title:
Product NameThe product's name.
Nested Schema : Money
Type:
objectA base / value business entity used to represent money.
Show Source
-
unit(required): string
Refers to the currency (ISO4217 norm uses 3 letters to define the currency).
-
value(required): number
(float)
A positive floating point number.
Nested Schema : TimePeriod
Type:
objectA period of time.
Show Source
-
endDateTime: string
(date-time)
Title:
End Time PeriodThe end of the time period in IETC-RFC-3339 format. -
startDateTime: string
(date-time)
Title:
Start Time PeriodThe start of the time period in IETC-RFC-3339 format.
400 Response
Bad Request
Root Schema : Error
Type:
objectThis 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.
401 Response
Unauthorized
Root Schema : Error
Type:
objectThis 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.
403 Response
Forbidden
Root Schema : Error
Type:
objectThis 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.
404 Response
Not Found
Root Schema : Error
Type:
objectThis 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.
405 Response
Method Not Allowed
Root Schema : Error
Type:
objectThis 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.
409 Response
Conflict
Root Schema : Error
Type:
objectThis 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.
500 Response
Internal Server Error
Root Schema : Error
Type:
objectThis 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.
Examples
The following example shows how to get a specific transferred balance 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/transferBalance/0.0.0.1+-event-audit-transfer_balance+332070103776495457'
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": 24.0,
"units": "Free Seconds",
"@baseType": "Quantity",
"@schemaLocation": null,
"@type": "Quantity"
},
"bucket": {
"id": "0.0.0.1+-balance_group+2083846+1000095+38",
"href": "http://host:port/brm/prepayBalanceManagement/v4/bucket/0.0.0.1+-balance_group+2083846+1000095+38",
"name": null,
"@baseType": "BucketRef",
"@schemaLocation": null,
"@type": "BucketRef",
"@referredType": null
},
"channel": null,
"confirmationDate": "2021-09-06T17:22:33+05:30",
"costOwner": "originator",
"description": "",
"href": "http://host:port/brm/prepayBalanceManagement/v4/transferBalance/0.0.0.1+-event-audit-transfer_balance+332070103776495457",
"id": "0.0.0.1+-event-audit-transfer_balance+332070103776495457",
"impactedBucket": [
{
"@baseType": "ImpactedBucket",
"@schemaLocation": null,
"@type": "ImpactedBucket",
"amountAfter": null,
"amountBefore": null,
"bucket": {
"id": "0.0.0.1+-balance_group+2083846+1000095+42",
"href": "http://host:port/brm/prepayBalanceManagement/v4/bucket/0.0.0.1+-balance_group+2083846+1000095+42",
"name": null,
"@baseType": "BucketRef",
"@schemaLocation": null,
"@type": "BucketRef",
"@referredType": null
},
"confirmationDate": "2021-09-06T17:22:33+05:30",
"description": null,
"item": [
{
"@baseType": "ImpactedBucketItem",
"@schemaLocation": null,
"@type": "ImpactedBucketItem",
"amount": {
"amount": 6.0,
"units": "Free Seconds",
"@baseType": "Quantity",
"@schemaLocation": null,
"@type": "Quantity"
},
"description": null,
"itemType": "debit",
"name": "transfer cost-originator",
"reason": null
}
],
"name": null,
"requestedDate": "2021-09-06T17:22:33+05:30"
},
{
"@baseType": "ImpactedBucket",
"@schemaLocation": null,
"@type": "ImpactedBucket",
"amountAfter": null,
"amountBefore": null,
"bucket": {
"id": "0.0.0.1+-balance_group+2083846+1000095+44",
"href": "http://host:port/brm/prepayBalanceManagement/v4/bucket/0.0.0.1+-balance_group+2083846+1000095+44",
"name": null,
"@baseType": "BucketRef",
"@schemaLocation": null,
"@type": "BucketRef",
"@referredType": null
},
"confirmationDate": "2021-09-06T17:22:33+05:30",
"description": null,
"item": [
{
"@baseType": "ImpactedBucketItem",
"@schemaLocation": null,
"@type": "ImpactedBucketItem",
"amount": {
"amount": 4.0,
"units": "Free Seconds",
"@baseType": "Quantity",
"@schemaLocation": null,
"@type": "Quantity"
},
"description": null,
"itemType": "debit",
"name": "transfer cost-originator",
"reason": null
}
],
"name": null,
"requestedDate": "2021-09-06T17:22:33+05:30"
},
{
"@baseType": "ImpactedBucket",
"@schemaLocation": null,
"@type": "ImpactedBucket",
"amountAfter": null,
"amountBefore": null,
"bucket": {
"id": "0.0.0.1+-balance_group+2083846+1000095+40",
"href": "http://host:port/brm/prepayBalanceManagement/v4/bucket/0.0.0.1+-balance_group+2083846+1000095+40",
"name": null,
"@baseType": "BucketRef",
"@schemaLocation": null,
"@type": "BucketRef",
"@referredType": null
},
"confirmationDate": "2021-09-06T17:22:33+05:30",
"description": null,
"item": [
{
"@baseType": "ImpactedBucketItem",
"@schemaLocation": null,
"@type": "ImpactedBucketItem",
"amount": {
"amount": 10.0,
"units": "Free Seconds",
"@baseType": "Quantity",
"@schemaLocation": null,
"@type": "Quantity"
},
"description": null,
"itemType": "debit",
"name": "originator",
"reason": null
}
],
"name": null,
"requestedDate": "2021-09-06T17:22:33+05:30"
},
{
"@baseType": "ImpactedBucket",
"@schemaLocation": null,
"@type": "ImpactedBucket",
"amountAfter": null,
"amountBefore": null,
"bucket": {
"id": "0.0.0.1+-balance_group+2083846+1000095+42",
"href": "http://host:port/brm/prepayBalanceManagement/v4/bucket/0.0.0.1+-balance_group+2083846+1000095+42",
"name": null,
"@baseType": "BucketRef",
"@schemaLocation": null,
"@type": "BucketRef",
"@referredType": null
},
"confirmationDate": "2021-09-06T17:22:33+05:30",
"description": null,
"item": [
{
"@baseType": "ImpactedBucketItem",
"@schemaLocation": null,
"@type": "ImpactedBucketItem",
"amount": {
"amount": 4.0,
"units": "Free Seconds",
"@baseType": "Quantity",
"@schemaLocation": null,
"@type": "Quantity"
},
"description": null,
"itemType": "debit",
"name": "originator",
"reason": null
}
],
"name": null,
"requestedDate": "2021-09-06T17:22:33+05:30"
},
{
"@baseType": "ImpactedBucket",
"@schemaLocation": null,
"@type": "ImpactedBucket",
"amountAfter": null,
"amountBefore": null,
"bucket": {
"id": "0.0.0.1+-balance_group+2090186+1000095+22",
"href": "http://host:port/brm/prepayBalanceManagement/v4/bucket/0.0.0.1+-balance_group+2090186+1000095+22",
"name": null,
"@baseType": "BucketRef",
"@schemaLocation": null,
"@type": "BucketRef",
"@referredType": null
},
"confirmationDate": "2021-09-06T17:22:33+05:30",
"description": null,
"item": [
{
"@baseType": "ImpactedBucketItem",
"@schemaLocation": null,
"@type": "ImpactedBucketItem",
"amount": {
"amount": -10.0,
"units": "Free Seconds",
"@baseType": "Quantity",
"@schemaLocation": null,
"@type": "Quantity"
},
"description": null,
"itemType": "credit",
"name": "receiver",
"reason": null
}
],
"name": null,
"requestedDate": "2021-09-06T17:22:33+05:30"
},
{
"@baseType": "ImpactedBucket",
"@schemaLocation": null,
"@type": "ImpactedBucket",
"amountAfter": null,
"amountBefore": null,
"bucket": {
"id": "0.0.0.1+-balance_group+2090186+1000095+24",
"href": "http://host:port/brm/prepayBalanceManagement/v4/bucket/0.0.0.1+-balance_group+2090186+1000095+24",
"name": null,
"@baseType": "BucketRef",
"@schemaLocation": null,
"@type": "BucketRef",
"@referredType": null
},
"confirmationDate": "2021-09-06T17:22:33+05:30",
"description": null,
"item": [
{
"@baseType": "ImpactedBucketItem",
"@schemaLocation": null,
"@type": "ImpactedBucketItem",
"amount": {
"amount": -4.0,
"units": "Free Seconds",
"@baseType": "Quantity",
"@schemaLocation": null,
"@type": "Quantity"
},
"description": null,
"itemType": "credit",
"name": "receiver",
"reason": null
}
],
"name": null,
"requestedDate": "2021-09-06T17:22:33+05:30"
}
],
"logicalResource": {
"@baseType": "LogicalResourceRef",
"@referredType": null,
"@schemaLocation": null,
"@type": "LogicalResourceRef",
"href": null,
"id": null,
"name": null,
"value": "964-20210827-041409-0-9169--146802944-cagbu-mum-54"
},
"partyAccount": {
"id": "0.0.0.1+-account+2084346",
"href": null,
"description": null,
"name": "Sunita K",
"status": "active",
"@baseType": "PartyAccountRef",
"@schemaLocation": null,
"@type": "PartyAccountRef",
"@referredType": null
},
"product": {
"id": "0.0.0.1+-service-telco-gsm-telephony+2081030",
"href": null,
"name": "ServiceTelcoGsmTelephony",
"@baseType": "ProductRef",
"@schemaLocation": null,
"@type": "ProductRef",
"@referredType": null
},
"reason": null,
"receiver": null,
"receiverBucket": {
"id": "0.0.0.1+-balance_group+2090186+1000095+20",
"href": "http://host:port/brm/prepayBalanceManagement/v4/bucket/0.0.0.1+-balance_group+2090186+1000095+20",
"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": "243-20210827-041843-1-9169--146802944-cagbu-mum-54"
},
"receiverPartyAccount": {
"id": "0.0.0.1+-account+2090314",
"href": null,
"description": null,
"name": "Deepak Kumar",
"status": "active",
"@baseType": "PartyAccountRef",
"@schemaLocation": null,
"@type": "PartyAccountRef",
"@referredType": null
},
"receiverProduct": {
"id": "0.0.0.1+-service-telco-gsm-telephony+2092746",
"href": null,
"name": "ServiceTelcoGsmTelephony",
"@baseType": "ProductRef",
"@schemaLocation": null,
"@type": "ProductRef",
"@referredType": null
},
"relatedParty": null,
"requestedDate": "2021-09-06T17:22:33+05:30",
"requestor": null,
"status": "CONFIRMED",
"transferCost": {
"amount": 10.0,
"units": "Free Seconds",
"@baseType": "Quantity",
"@schemaLocation": null,
"@type": "Quantity"
},
"usageType": "other"
}