Get Balance Transfer Details
get
/bcws/webresources/v1.0/billunits/balancegroups/transferbalance
Gets the details of the balance transfer that matches the specified ID.
Request
Query Parameters
-
id(required): string
The ID of the balance transfer to get.
-
sourceRefId(required): string
The ID of the balance group or service, or the service/MSISDN number that was the source of the balance transfer.
-
sourceRefType(required): string
The type of the sourceRefId.
-
targetRefId(required): string
The ID of the balance group or service, or the service/MSISDN number that was the target of the balance transfer.
-
targetRefType(required): string
The type of the targetRefId.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
The balance transfer details were returned successfully.
Root Schema : transferBalanceDetails
Type:
Show Source
object
-
chargeDestination: boolean
The destination for a charge.
-
chargeSource: boolean
The source for a charge.
-
extension: object
extension
The extended attributes.
-
id(required): string
The transfer's ID.
-
sourceAccountRef(required): object
ResourceRef
-
sourceImpactedBucket(required): array
sourceImpactedBucket
The impacted bucket at the source.
-
sourceRef(required): object
SourceRef
The balance transfer's source.
-
sourceTransferFee(required): object
SourceTransferFee
The transfer fee to charge the source.
-
targetAccountRef(required): object
ResourceRef
-
targetImpactedBucket(required): array
targetImpactedBucket
-
targetRef(required): object
TargetRef
The balance transfer's target.
-
targetTransferFee(required): object
TargetTransferFee
The transfer fee to charge the target.
-
transferAmount(required): number
The transfer amount.
-
transferAmountType: integer
(int32)
The transfer amount's type.
-
transferDate(required): string
(date-time)
The date and time of the transfer.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : ResourceRef
Type:
Show Source
object
-
id(required): string
The ID.
-
uri: string
The Uniform Resource Identifier (URI) associated with the resource.
Nested Schema : sourceImpactedBucket
Type:
array
The impacted bucket at the source.
Show Source
-
Array of:
object SourceImpactedBucket
The impacted bucket at the source.
Nested Schema : SourceRef
Type:
object
The balance transfer's source.
Show Source
-
id(required): string
The source's ID.
-
type(required): string
The source's type. Can be one of the following:
- balanceGroup
- account
- service
Nested Schema : SourceTransferFee
Type:
object
The transfer fee to charge the source.
Show Source
-
amount: number
The amount of the fee.
-
feeTax: number
The tax on the fee.
-
resourceId: integer
(int32)
The ID of the resource associated with the fee.
Nested Schema : TargetRef
Type:
object
The balance transfer's target.
Show Source
-
id(required): string
The target's ID.
-
type(required): string
The target's type. Can be one of the following:
- balanceGroup
- account
- service
Nested Schema : TargetTransferFee
Type:
object
The transfer fee to charge the target.
Show Source
-
amount: number
The amount of the fee.
-
feeTax: number
The tax on the fee.
-
resourceId: integer
(int32)
The ID of the resource associated with the fee.
Nested Schema : SourceImpactedBucket
Type:
object
The impacted bucket at the source.
Show Source
-
amount(required): number
The amount in the bucket.
-
validFrom: string
(date-time)
The date and time the bucket's validity starts.
-
validTo: string
(date-time)
The date and time the bucket's validity ends.
Nested Schema : TargetImpactedBucket
Type:
Show Source
object
-
amount(required): number
The amount in the bucket.
-
validFrom: string
(date-time)
The date and time the bucket's validity starts.
-
validTo: string
(date-time)
The date and time the bucket's validity ends.
400 Response
The request isn't valid.
500 Response
An internal server error occurred.
Examples
This example shows how to get details about a balance transfer by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Use cURL".
cURL Command
curl -X GET 'http://hostname:port/bcws/webresources/version/billunits/balancegroups/transferbalance?sourceRefType=balanceGroup&sourceRefId=0.0.0.1+-balance_group+88224&id=0.0.0.1+-event-audit-transfer_balance+3329&targetRefType=balanceGroup&targetRefId=0.0.0.1+-balance_group+56108'
where:
- hostname is the URL for the Billing Care REST server.
- port is the port for the Billing Care REST server.
- version is the version of the API you're using, such as v1.0.
This example specifies all possible query parameters (sourceRefType, sourceRefId, id, targetRefType, and targetRefId). Alternatively, you could specify only the source information, only the target information, or only the event ID.
Example of Response Body
This example shows the contents of the response body in JSON format. This balance transfer applies to multiple sub-balances and a fee is charged to both the source and target account.
[
{
"extension":null,
"id":"0.0.0.1+-event-audit-transfer_balance+3329",
"sourceAccountRef":{
"id":"0.0.0.1+-account+87328",
"uri":"http://host:port/bcws/webresources/v1.0/accounts/0.0.0.1+-account+87328"
},
"targetAccountRef":{
"id":"0.0.0.1+-account+55852",
"uri":"http://host:port/bcws/webresources/v1.0/accounts/0.0.0.1+-account+55852"
},
"transferDate":1635162211000,
"sourceRef":{
"id":"0.0.0.1+-balance_group+88224",
"type":"balanceGroup"
},
"targetRef":{
"id":"0.0.0.1+-balance_group+56108",
"type":"balanceGroup"
},
"transferAmount":2400,
"transferAmountType":1000095,
"chargeSource":true,
"chargeDestination":true,
"sourceImpactedBucket":[
{
"validFrom":1630496557000,
"validTo":1641040957000,
"amount":200
},
{
"validFrom":1633478400000,
"validTo":0,
"amount":2200
}
],
"targetImpactedBucket":[
{
"validFrom":1630496557000,
"validTo":1641040957000,
"amount":-200
},
{
"validFrom":1633478400000,
"validTo":0,
"amount":-2200
}
],
"sourceTransferFee":{
"amount":5,
"feeTax":0.5,
"resourceId":840
},
"targetTransferFee":{
"amount":5,
"feeTax":0.5,
"resourceId":840
}
}
]