Get a Transfer Balance by ID

get

/transferBalance/{id}

Gets the specified transfer balance.

Request

Path Parameters
Query Parameters
  • The list of comma-separated fields to return in the response.
    Example:
    requestor,requestedDate

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The transfer balance was retrieved successfully.
Body ()
Root Schema : TransferBalance
Type: object
A balance being transferred between buckets.
Show Source
Nested Schema : Quantity
Type: object
The amount in a given unit.
Show Source
Nested Schema : Bucket Ref
Type: object
Title: Bucket Ref
A reference to a bucket.
Show Source
Nested Schema : ChannelRef
Type: object
A reference to a channel.
Show Source
Nested Schema : impactedBucket
Type: array
Buckets impacted by the request.
Show Source
Nested Schema : Logical Resource Ref
Type: object
Title: Logical Resource Ref
A reference to a logical resource.
Show Source
Nested Schema : Party Account Ref
Type: object
Title: Party Account Ref
A reference to a party account.
Show Source
Nested Schema : Product Ref
Type: object
Title: Product Ref
A reference to a product.
Show Source
Nested Schema : Related Party
Type: object
Title: Related Party
A party related to another object.
Show Source
Nested Schema : relatedParty
Type: array
Parties related to the transfer.
Show Source
Nested Schema : ImpactedBucket
Type: object
A bucket impacted by a balance top-up, adjustment, transfer, or reservation.
Show Source
Nested Schema : item
Type: array
Minimum Number of Items: 1
The impacted bucket items.
Show Source
Nested Schema : ImpactedBucketItem
Type: object
An impact item that affects an ImpactedBucket object.
Show Source

400 Response

The request isn't valid.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

401 Response

The client doesn't have the correct privileges.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

403 Response

The request wasn't authorized.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

404 Response

The requested resource couldn't be found.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

405 Response

This method is not allowed.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

409 Response

The request could not be processed due to the conflict with the existing state of the resource.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

500 Response

The system encountered an internal error.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source
Back to Top

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": "2025-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": "2025-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": "2025-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": "2025-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": "2025-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": "2025-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": "2025-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": "2025-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": "2025-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": "2025-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": "2025-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": "2025-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": "2025-09-06T17:22:33+05:30"
      }
   ],
   "logicalResource": {
      "@baseType": "LogicalResourceRef",
      "@referredType": null,
      "@schemaLocation": null,
      "@type": "LogicalResourceRef",
      "href": null,
      "id": null,
      "name": null,
      "value": "964-20250827-041409-0-9169--146802944-cagbu-mum-54"
   },
   "partyAccount": {
      "id": "0.0.0.1+-account+2084346",
      "href": null,
      "description": null,
      "name": "Adam Baker",
      "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-20250827-041843-1-9169--146802944-cagbu-mum-54"
   },
   "receiverPartyAccount": {
      "id": "0.0.0.1+-account+2090314",
      "href": null,
      "description": null,
      "name": "John Miller",
      "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": "2025-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"
}
Back to Top