Get Transfer Balances

get

/transferBalance

Gets transfer balances that match the query criteria.

Request

Query Parameters
  • The list of comma-separated fields to return in the response.
    Example:
    channel,costOwner
  • The maximum number of results to return. For example, use limit=10 to return the first 10 results only.
    Example:
    10
  • The number of results to offset the response by. For example, use offset=10 to return results 10 and higher.
    Example:
    0

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Success
Headers
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : Transfer Balance
Type: object
Title: Transfer Balance
A balance being transferred between buckets.
Show Source
Nested Schema : Quantity
Type: object
An 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 : Channel Ref
Type: object
Title: Channel Ref
A reference to a channel.
Show Source
Nested Schema : logicalResource
Type: array
Minimum Number of Items: 1
Logical resources associated with the transfer.
Show Source
Nested Schema : Party Account Ref
Type: object
Title: Party Account Ref
A reference to a party account.
Show Source
Nested Schema : product
Type: array
Products associated with the transfer.
Show Source
Nested Schema : Related Party
Type: object
Title: Related Party
A party related to another object.
Show Source
Nested Schema : Logical Resource Ref
Type: object
Title: Logical Resource Ref
A reference to a logical resource.
Show Source
Nested Schema : Product Ref
Type: object
Title: Product Ref
A reference to a product.
Show Source
Nested Schema : relatedParty
Type: array
A party related to the transfer.
Show Source
Nested Schema : Money
Type: object
A base / value business entity used to represent money.
Show Source
Nested Schema : TimePeriod
Type: object
A period of time.
Show Source

400 Response

Bad Request
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

401 Response

Unauthorized
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

403 Response

Forbidden
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

404 Response

Not Found
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

405 Response

Method Not Allowed
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

409 Response

Conflict
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

500 Response

Internal Server Error
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
Back to Top

Examples

The following example shows how to get transferred balances by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

The request uses query parameters to show two transfers for a specified originating product. You can use different query parameters to filter transfers by different elements, such as logical resources, receiving products, originating and sending buckets, originating and receiving accounts, currency or noncurrency resource, cost owner, and so on.

curl -X GET 'http://host:port/brm/prepayBalanceManagement/version/transferBalance?product.id=0.0.0.1+-service-telco-gsm-telephony+2081030&limit=2'

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 Kumar",
                     "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"
       },
       {
              "@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+34",
                     "href": "http://host:port/brm/prepayBalanceManagement/v4/bucket/0.0.0.1+-balance_group+2083846+1000095+34",
                     "name": null,
                     "@baseType": "BucketRef",
                     "@schemaLocation": null,
                     "@type": "BucketRef",
                     "@referredType": null
              },
              "channel": null,
              "confirmationDate": "2021-09-06T17:19:32+05:30",
              "costOwner": "none",
              "description": "",
              "href": "http://host:port/brm/prepayBalanceManagement/v4/transferBalance/0.0.0.1+-event-audit-transfer_balance+332070103776500416",
              "id": "0.0.0.1+-event-audit-transfer_balance+332070103776500416",
              "impactedBucket": [
                     {
                            "@baseType": "ImpactedBucket",
                            "@schemaLocation": null,
                            "@type": "ImpactedBucket",
                            "amountAfter": null,
                            "amountBefore": null,
                            "bucket": {
                                   "id": "0.0.0.1+-balance_group+2083846+1000095+32",
                                   "href": "http://host:port/brm/prepayBalanceManagement/v4/bucket/0.0.0.1+-balance_group+2083846+1000095+32",
                                   "name": null,
                                   "@baseType": "BucketRef",
                                   "@schemaLocation": null,
                                   "@type": "BucketRef",
                                   "@referredType": null
                            },
                            "confirmationDate": "2021-09-06T17:19:32+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:19:32+05:30"
                     },
                     {
                            "@baseType": "ImpactedBucket",
                            "@schemaLocation": null,
                            "@type": "ImpactedBucket",
                            "amountAfter": null,
                            "amountBefore": null,
                            "bucket": {
                                   "id": "0.0.0.1+-balance_group+2083846+1000095+30",
                                   "href": "http://host:port/brm/prepayBalanceManagement/v4/bucket/0.0.0.1+-balance_group+2083846+1000095+30",
                                   "name": null,
                                   "@baseType": "BucketRef",
                                   "@schemaLocation": null,
                                   "@type": "BucketRef",
                                   "@referredType": null
                            },
                            "confirmationDate": "2021-09-06T17:19:32+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:19:32+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:19:32+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:19:32+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:19:32+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:19:32+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 Kumar",
                     "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:19:32+05:30",
              "requestor": null,
              "status": "CONFIRMED",
              "transferCost": null,
              "usageType": "other"
       }
]
Back to Top