Create a Transfer Balance
/transferBalance
Request
There are no request parameters for this operation.
- application/json;charset=utf-8
object
Transfer Balance Create
-
@baseType: string
Title:
Base Type
The object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON-Schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
amount(required): object
Quantity
An amount in a given unit.
-
bucket(required): object
Bucket Ref
Title:
Bucket Ref
A reference to a bucket. -
channel(required): object
Channel Ref
Title:
Channel Ref
A reference to a channel. -
costOwner: string
Title:
Cost OwnerType
Allowed Values:[ "originator", "receiver" ]
The type of cost owner. -
description: string
Title:
Description
The transfer's description. -
logicalResource(required): array
logicalResource
Minimum Number of Items:
1
Logical resources associated with the transfer. -
product: array
product
Products associated with the transfer.
-
reason(required): string
Title:
Reason
The reason for the transfer. -
receiver: object
Related Party
Title:
Related Party
A party related to another object. -
receiverBucket(required): object
Bucket Ref
Title:
Bucket Ref
A reference to a bucket. -
receiverBucketUsageType(required): string
Title:
Usage Type
Allowed 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 Ref
A reference to a logical resource. -
receiverProduct: object
Product Ref
Title:
Product Ref
A reference to a product. -
requestor: object
Related Party
Title:
Related Party
A party related to another object. -
transferCost: object
Money
A base / value business entity used to represent money.
-
usageType(required): string
Title:
Usage Type
Allowed 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.
object
-
amount: number
(float)
Default Value:
1
Numeric value in a given unit. -
units: string
Unit
object
Bucket Ref
-
@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.
object
Channel Ref
-
@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.
array
1
-
Array of:
object Logical Resource Ref
Title:
Logical Resource Ref
A reference to a logical resource.
array
-
Array of:
object Product Ref
Title:
Product Ref
A reference to a product.
object
Related Party
-
@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.
object
Logical Resource Ref
-
@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.
object
Product Ref
-
@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.
object
-
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.
object
-
endDateTime: string
(date-time)
Title:
End Time Period
The end of the time period in IETC-RFC-3339 format. -
startDateTime: string
(date-time)
Title:
Start Time Period
The start of the time period in IETC-RFC-3339 format.
Response
- application/json;charset=utf-8
201 Response
object
Transfer Balance
-
@baseType: string
Title:
Base Type
The object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON-Schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
amount: object
Quantity
An amount in a given unit.
-
bucket: object
Bucket Ref
Title:
Bucket Ref
A reference to a bucket. -
channel(required): object
Channel Ref
Title:
Channel Ref
A reference to a channel. -
confirmationDate: string
(date-time)
Title:
Confirmation Date
The date the transfer was confirmed. -
costOwner: string
Title:
Cost OwnerType
Allowed Values:[ "originator", "receiver" ]
The type of cost owner. -
description: string
Title:
Description
The transfer's description. -
href(required): string
Title:
Href
The transferred balance's href. -
id(required): string
Title:
ID
The transferred balance's ID. -
logicalResource(required): array
logicalResource
Minimum Number of Items:
1
Logical resources associated with the transfer. -
partyAccount: object
Party Account Ref
Title:
Party Account Ref
A reference to a party account. -
product: array
product
Products associated with the transfer.
-
reason(required): string
Title:
Reason
The reason for the transfer. -
receiver: object
Related Party
Title:
Related Party
A party related to another object. -
receiverBucket: object
Bucket Ref
Title:
Bucket Ref
A reference to a bucket. -
receiverBucketUsageType: string
Title:
Usage Type
Allowed 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 Ref
A reference to a logical resource. -
receiverProduct: object
Product Ref
Title:
Product Ref
A reference to a product. - relatedParty: array relatedParty
-
requestedDate: string
(date-time)
Title:
Requested Date
The date that the request was received. -
requestor: object
Related Party
Title:
Related Party
A party related to another object. -
status(required): string
Title:
Action Status Type
Allowed 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 Type
Allowed 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.
object
-
amount: number
(float)
Default Value:
1
Numeric value in a given unit. -
units: string
Unit
object
Bucket Ref
-
@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.
object
Channel Ref
-
@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.
array
1
-
Array of:
object Logical Resource Ref
Title:
Logical Resource Ref
A reference to a logical resource.
object
Party Account Ref
-
@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.
array
-
Array of:
object Product Ref
Title:
Product Ref
A reference to a product.
object
Related Party
-
@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.
object
Logical Resource Ref
-
@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.
object
Product Ref
-
@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.
object
-
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.
object
-
endDateTime: string
(date-time)
Title:
End Time Period
The end of the time period in IETC-RFC-3339 format. -
startDateTime: string
(date-time)
Title:
Start Time Period
The start of the time period in IETC-RFC-3339 format.
400 Response
object
-
@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
object
-
@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
object
-
@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
object
-
@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
object
-
@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
object
-
@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 examples shows how to create transferred balances by submitting POST requests on the REST resource using cURL. For more information about cURL, see Use cURL.
The -d option specifies the file to attach as the request body.
curl -X POST 'http://host:port/brm/prepayBalanceManagement/version/transferBalance' -d @transferBalanceCreate.json
Example of Request Body for Transferring a Currency Balance
The following is an example of the contents of the transferBalanceCreate.json file sent as the request body to transfer a currency balance and include a transfer cost.
You can specify any combination of sender and receiver bucket, product, or logical resource, and BRM will locate the correct balance groups for the transfer. As in the example, with a sender bucket and a receiver product, the sender and receiver element type do not have to match.
{ "amount":{ "amount":"20", "units":"USD" }, "costOwner":"receiver", "transferCost":{ "amount":"5", "units":"USD" }, "bucket":{ "id" : "0.0.0.1+-balance_group+2186073+840+0" }, "receiverProduct":{ "id": "0.0.0.1+-service-telco-gsm-telephony+2184506" } }
Example of Request Body for Transferring a Noncurrency Balance
The following is an example of the contents of the transferBalanceCreate.json file sent as the request body to transfer a noncurrency balance and include a transfer cost.
{ "amount":{ "amount":"10", "units":"Free Minutes" }, "costOwner":"originator", "transferCost":{ "amount":"1", "units":"Free Minutes" }, "logicalResource":{ "value" : "0049100501" }, "receiverProduct":{ "id": "0.0.0.1+-service-telco-gsm-telephony+2202128" } }
Example of Response Body
The following is an example of the response body in JSON format. It looks the same for currency and noncurrency transfers.
{
"@baseType": null,
"@schemaLocation": null,
"@type": null,
"amount": null,
"bucket": null,
"channel": null,
"confirmationDate": null,
"costOwner": null,
"description": null,
"href": "http://host:port/brm/prepayBalanceManagement/v4/transferBalance/0.0.0.1+-event-audit-transfer_balance+330134963311715969",
"id": "0.0.0.1+-event-audit-transfer_balance+330134963311715969",
"impactedBucket": null,
"logicalResource": null,
"partyAccount": null,
"product": null,
"reason": null,
"receiver": null,
"receiverBucket": null,
"receiverBucketUsageType": null,
"receiverLogicalResource": null,
"receiverPartyAccount": null,
"receiverProduct": null,
"relatedParty": null,
"requestedDate": null,
"requestor": null,
"status": "CONFIRMED",
"transferCost": null,
"usageType": null
}