Jump to

• Request
• Response
• Examples

Get Balance Transfer Details by Transfer Event ID

get

/bcws/webresources/v1.0/billunits/balancegroups/transferbalance/{id}

Gets the details of the balance transfer for the transfer event that matches the specified ID.

Request

Path Parameters

• id(required): string
  The ID of the balance transfer event to get.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The balance transfer details were returned successfully.

Body ()

Root Schema : transferBalanceDetails

Type: object

Show Source

• 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.

{
    "required":[
        "id",
        "sourceAccountRef",
        "sourceImpactedBucket",
        "sourceRef",
        "sourceTransferFee",
        "targetAccountRef",
        "targetImpactedBucket",
        "targetRef",
        "targetTransferFee",
        "transferAmount",
        "transferDate"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The transfer's ID."
        },
        "sourceAccountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "targetAccountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "transferDate":{
            "type":"string",
            "description":"The date and time of the transfer.",
            "format":"date-time"
        },
        "sourceRef":{
            "$ref":"#/components/schemas/SourceRef"
        },
        "targetRef":{
            "$ref":"#/components/schemas/TargetRef"
        },
        "transferAmount":{
            "type":"number",
            "description":"The transfer amount."
        },
        "transferAmountType":{
            "type":"integer",
            "description":"The transfer amount's type.",
            "format":"int32"
        },
        "chargeSource":{
            "type":"boolean",
            "description":"The source for a charge."
        },
        "chargeDestination":{
            "type":"boolean",
            "description":"The destination for a charge."
        },
        "sourceImpactedBucket":{
            "type":"array",
            "description":"The impacted bucket at the source.",
            "items":{
                "$ref":"#/components/schemas/SourceImpactedBucket"
            }
        },
        "targetImpactedBucket":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TargetImpactedBucket"
            }
        },
        "sourceTransferFee":{
            "$ref":"#/components/schemas/SourceTransferFee"
        },
        "targetTransferFee":{
            "$ref":"#/components/schemas/TargetTransferFee"
        }
    },
    "xml":{
        "name":"transferBalanceDetails"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : ResourceRef

Type: object

Show Source

• id(required): string
  The ID.
• uri: string
  The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"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.

{
    "type":"array",
    "description":"The impacted bucket at the source.",
    "items":{
        "$ref":"#/components/schemas/SourceImpactedBucket"
    }
}

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

{
    "required":[
        "id",
        "type"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The source's ID."
        },
        "type":{
            "type":"string",
            "description":"The source's type. Can be one of the following: <ul><li>balanceGroup</li><li>account</li><li>service</li></ul>"
        }
    },
    "description":"The balance transfer's source."
}

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.

{
    "type":"object",
    "properties":{
        "amount":{
            "type":"number",
            "description":"The amount of the fee."
        },
        "feeTax":{
            "type":"number",
            "description":"The tax on the fee."
        },
        "resourceId":{
            "type":"integer",
            "description":"The ID of the resource associated with the fee.",
            "format":"int32"
        }
    },
    "description":"The transfer fee to charge the source."
}

Nested Schema : targetImpactedBucket

Type: array

Show Source

• Array of: object TargetImpactedBucket

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TargetImpactedBucket"
    }
}

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

{
    "required":[
        "id",
        "type"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The target's ID."
        },
        "type":{
            "type":"string",
            "description":"The target's type. Can be one of the following: <ul><li>balanceGroup</li><li>account</li><li>service</li></ul>"
        }
    },
    "description":"The balance transfer's target."
}

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.

{
    "type":"object",
    "properties":{
        "amount":{
            "type":"number",
            "description":"The amount of the fee."
        },
        "feeTax":{
            "type":"number",
            "description":"The tax on the fee."
        },
        "resourceId":{
            "type":"integer",
            "description":"The ID of the resource associated with the fee.",
            "format":"int32"
        }
    },
    "description":"The transfer fee to charge the target."
}

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.

{
    "required":[
        "amount"
    ],
    "type":"object",
    "properties":{
        "validFrom":{
            "type":"string",
            "description":"The date and time the bucket's validity starts.",
            "format":"date-time"
        },
        "validTo":{
            "type":"string",
            "description":"The date and time the bucket's validity ends.",
            "format":"date-time"
        },
        "amount":{
            "type":"number",
            "description":"The amount in the bucket."
        }
    },
    "description":"The impacted bucket at the source."
}

Nested Schema : TargetImpactedBucket

Type: object

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.

{
    "required":[
        "amount"
    ],
    "type":"object",
    "properties":{
        "validFrom":{
            "type":"string",
            "description":"The date and time the bucket's validity starts.",
            "format":"date-time"
        },
        "validTo":{
            "type":"string",
            "description":"The date and time the bucket's validity ends.",
            "format":"date-time"
        },
        "amount":{
            "type":"number",
            "description":"The amount in the bucket."
        }
    }
}

400 Response

The request isn't valid.

500 Response

An internal server error occurred.

Back to Top

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/0.0.0.1+-event-audit-transfer_balance+33323'

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 the transfer event ID in the path rather than as a query parameter.

Example of Response Body

This example shows the contents of the response body in JSON format. This balance transfer applies toa single sub-balance and a fee is charged to both the source and target account.

[
   {
      "extension":null,
      "id":"0.0.0.1+-event-audit-transfer_balance+33323",
      "sourceAccountRef":{
         "id":"0.0.0.1+-account+329848",
         "uri":"http://host:port/bcws/webresources/v1.0/accounts/0.0.0.1+-account+329848"
      },
      "targetAccountRef":{
         "id":"0.0.0.1+-account+328088",
         "uri":"http://host:port/bcws/webresources/v1.0/accounts/0.0.0.1+-account+328088"
      },
      "transferDate":1636625864000,
      "sourceRef":{
         "id":"0.0.0.1+-balance_group+328056",
         "type":"balanceGroup"
      },
      "targetRef":{
         "id":"0.0.0.1+-balance_group+331672",
         "type":"balanceGroup"
      },
      "transferAmount":10,
      "transferAmountType":840,
      "chargeSource":true,
      "chargeDestination":true,
      "sourceImpactedBucket":[
         {
            "validFrom":1636588800000,
            "validTo":0,
            "amount":10
         }
      ],
      "targetImpactedBucket":[
         {
            "validFrom":1636588800000,
            "validTo":0,
            "amount":-10
         }
      ],
      "sourceTransferFee":{
         "amount":5,
         "feeTax":0.5,
         "resourceId":840
      },
      "targetTransferFee":{
         "amount":5,
         "feeTax":0.5,
         "resourceId":840
      }
   }
]

Back to Top