tmf-prepay-balance-management-biz
balanceActionHistory
https://[localhost]:[port]/tmf-api/prepayBalanceManagement/v4/{businessId}/balanceActionHistory
URL PARAMS
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit. | Y |
Header
| name | value | description | required |
|---|---|---|---|
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | N |
Security Headers
| Name | Value | Description |
|---|---|---|
| client_id | string | Client Id value for Client Id Enforcement policy. Environment Specific Value. Eg: 6f0ed16a7b494d76b2d60e05bc3b3332 |
| client_secret | string | Client secret value for Client Id Enforcement policy. Environment Specific Value, eg: e4CD4D43449846aA9D8Cb9c43fAd324a |
Query Param
| name | type | description | required |
|---|---|---|---|
| product.id | string | To list the topupHistory of a specific seviceInternalId example: "32855003" | Y |
| dateTime.gte | string | startDateTime to filter the topupHistory example: "2022-09-26T00:00:00" | Y |
| dateTime.lte | string | endDateTime to filter the topupHistory example: "2021-11-18T00:00:00" | Y |
| @type | string | When sub-classing, this defines the sub-class entity name example: "TopupBalance" | Y |
| limit | string | maximum no of records to retrieve example: "3" | N |
Response
In this section all the possible data structures received by the client at the moment of responding the method are defined.
Possible response success
This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.
[ 200 ]
OK - listTopupHistory request processed successfully, response body contains an entity corresponding to the requested resource.
[
{
"@type": "TopupBalance",
"description": "CWC_ESB,1,1,123456789:rdOnlineInMarket,WEB,JAM",
"confirmationDate": "2022-11-08T00:25:18.000-05:00",
"@baseType": "Action",
"amount": {
"amount": 1.00,
"units": "JMD"
},
"product": [
{
"id": "32970253",
"name": "serviceInternalId"
}
],
"partyAccount": {
"id": "32795117",
"name": "owningAccountInternalId"
},
"channel": {
"id": "11006",
"name": "limeware"
},
"logicalResource": [
{
"@type": "MSISDN",
"value": "18765544355"
}
],
"relatedParty": [
{
"id": "-1",
"name": "batchNumber"
},
{
"id": "11006",
"name": "rechargeId"
},
{
"id": "8347003",
"name": "rechargeId2"
},
{
"id": "NON VOUCHER",
"name": "cardNumber"
},
{
"id": "",
"name": "serialNumber"
},
{
"id": "1.0",
"name": "currencyConvRate"
}
],
"impactedBucket": [
{
"impactedBucketItem": [
{
"id": "1",
"@baseType": "BucketBalance",
"name": "primary balance",
"usageType": "Currency",
"amount": {
"amount": 600.31,
"units": "JMD"
},
"validFor": {
"endDateTime": "2022-11-29T00:00:00.000-05:00"
}
},
{
"id": "32",
"@baseType": "BucketBalance",
"name": "Roaming Data",
"usageType": "MB",
"amount": {
"amount": 0.00,
"units": "MB"
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
},
{
"id": "2",
"@baseType": "BucketBalance",
"name": "Text Messages",
"usageType": "SMS",
"amount": {
"amount": 0.00,
"units": "SMS"
},
"validFor": {
"endDateTime": "2017-06-04T00:00:00.000-05:00"
}
},
{
"id": "33",
"@baseType": "BucketBalance",
"name": "IDD Credit Balance",
"usageType": "Currency",
"amount": {
"amount": 0.00,
"units": "JMD"
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
},
{
"id": "3",
"@baseType": "BucketBalance",
"name": "International Minutes",
"usageType": "mins",
"amount": {
"amount": 72000.00,
"units": "mins"
},
"validFor": {
"endDateTime": "2022-11-05T10:42:47.000-05:00"
}
},
{
"id": "4",
"@baseType": "BucketBalance",
"name": "Free LIME text",
"usageType": "SMS",
"amount": {
"amount": 0.00,
"units": "SMS"
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
},
{
"id": "5",
"@baseType": "BucketBalance",
"name": "Local LIME Only Minutes",
"usageType": "mins",
"amount": {
"amount": 0.00,
"units": "mins"
},
"validFor": {
"endDateTime": "2017-06-14T00:00:00.000-05:00"
}
},
{
"id": "6",
"@baseType": "BucketBalance",
"name": "Text Messages",
"usageType": "SMS",
"amount": {
"amount": 0.00,
"units": "SMS"
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
},
{
"id": "7",
"@baseType": "BucketBalance",
"name": "Points",
"usageType": "Currency",
"amount": {
"amount": 0.00,
"units": "JMD"
},
"validFor": {
"endDateTime": "2017-06-14T00:00:00.000-05:00"
}
},
{
"id": "8",
"@baseType": "BucketBalance",
"name": "Off Net",
"usageType": "mins",
"amount": {
"amount": 0.00,
"units": "mins"
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
},
{
"id": "9",
"@baseType": "BucketBalance",
"name": "LIME Faves",
"usageType": "mins",
"amount": {
"amount": 0.00,
"units": "mins"
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
},
{
"id": "10",
"@baseType": "BucketBalance",
"name": "Bonus",
"usageType": "Currency",
"amount": {
"amount": 0.00,
"units": "JMD"
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
},
{
"id": "13",
"@baseType": "BucketBalance",
"name": "Double Bubble Bonus",
"usageType": "Currency",
"amount": {
"amount": 0.00,
"units": "JMD"
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
},
{
"id": "14",
"@baseType": "BucketBalance",
"name": "LIME Text Messages",
"usageType": "SMS",
"amount": {
"amount": 0.00,
"units": "SMS"
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
},
{
"id": "17",
"@baseType": "BucketBalance",
"name": "FMC_Balance",
"usageType": "Currency",
"amount": {
"amount": 0.00,
"units": "JMD"
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
},
{
"id": "16",
"@baseType": "BucketBalance",
"name": "Roaming Text Messages",
"usageType": "SMS",
"amount": {
"amount": 0.00,
"units": "SMS"
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
},
{
"id": "19",
"@baseType": "BucketBalance",
"name": "Flow Caribbean Voice Minutes",
"usageType": "mins",
"amount": {
"amount": 0.00,
"units": "mins"
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
},
{
"id": "18",
"@baseType": "BucketBalance",
"name": "Local LIME Only Minutes",
"usageType": "mins",
"amount": {
"amount": 0.00,
"units": "mins"
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
},
{
"id": "20",
"@baseType": "BucketBalance",
"name": "Flow Lend Balance",
"usageType": "Currency",
"amount": {
"amount": 0.00,
"units": "JMD"
},
"validFor": {
"endDateTime": "2032-09-26T02:31:26.000-05:00"
}
},
{
"id": "22",
"@baseType": "BucketBalance",
"name": "Anywhere Minutes",
"usageType": "mins",
"amount": {
"amount": 0.00,
"units": "mins"
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
},
{
"id": "25",
"@baseType": "BucketBalance",
"name": "Roaming Voice Minutes",
"usageType": "mins",
"amount": {
"amount": 0.00,
"units": "mins"
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
},
{
"id": "27",
"@baseType": "BucketBalance",
"name": "Loyalty Bonus",
"usageType": "Currency",
"amount": {
"amount": 13732.00,
"units": "JMD"
},
"validFor": {
"endDateTime": "2018-12-24T17:34:02.000-05:00"
}
},
{
"id": "28",
"@baseType": "BucketBalance",
"name": "Anywhere Local Minutes",
"usageType": "mins",
"amount": {
"amount": 0.00,
"units": "mins"
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
},
{
"id": "30",
"@baseType": "BucketBalance",
"name": "International Minutes",
"usageType": "mins",
"amount": {
"amount": 1800.00,
"units": "mins"
},
"validFor": {
"endDateTime": "2018-11-24T12:56:02.000-05:00"
}
},
{
"id": "36",
"@baseType": "BucketBalance",
"name": "AllNetMinutes",
"usageType": "mins",
"amount": {
"amount": 4611.00,
"units": "mins"
},
"validFor": {
"endDateTime": "2019-02-17T13:22:30.000-05:00"
}
},
{
"id": "35",
"@baseType": "BucketBalance",
"name": "Anywhere Minutes",
"usageType": "mins",
"amount": {
"amount": 0.00,
"units": "mins"
},
"validFor": {
"endDateTime": "2018-09-24T00:00:00.000-05:00"
}
},
{
"id": "38",
"@baseType": "BucketBalance",
"amount": {
"amount": 0.00
},
"validFor": {
"endDateTime": "2018-10-23T00:00:00.000-05:00"
}
},
{
"id": "39",
"@baseType": "BucketBalance",
"name": "POST_VOICE",
"usageType": "mins",
"amount": {
"amount": 36000.00,
"units": "mins"
},
"validFor": {
"endDateTime": "2022-10-28T06:03:20.000-05:00"
}
},
{
"id": "40",
"@baseType": "BucketBalance",
"name": "FMC_Balance",
"usageType": "Currency",
"amount": {
"amount": 12600.00,
"units": "JMD"
},
"validFor": {
"endDateTime": "2022-10-17T03:44:49.000-05:00"
}
},
{
"id": "41",
"@baseType": "BucketBalance",
"name": "Unlimited SMS",
"usageType": "SMS",
"amount": {
"amount": 200.00,
"units": "SMS"
},
"validFor": {
"endDateTime": "2022-10-28T06:03:20.000-05:00"
}
},
{
"id": "43",
"@baseType": "BucketBalance",
"amount": {
"amount": 0.00
},
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
}
}
],
"@type": "BalanceHistory"
},
{
"impactedBucketItem": [
{
"id": "2",
"@baseType": "BucketBalance",
"name": "Text Messages",
"usageType": "SMS",
"amount": {
"amount": 1.00,
"units": "SMS"
}
},
{
"id": "3",
"@baseType": "BucketBalance",
"name": "International Minutes",
"usageType": "mins",
"amount": {
"amount": 1.00,
"units": "mins"
}
},
{
"id": "4",
"@baseType": "BucketBalance",
"name": "Free LIME text",
"usageType": "SMS",
"amount": {
"amount": 1.00,
"units": "SMS"
}
},
{
"id": "6",
"@baseType": "BucketBalance",
"name": "Text Messages",
"usageType": "SMS",
"amount": {
"amount": 1.00,
"units": "SMS"
}
},
{
"id": "7",
"@baseType": "BucketBalance",
"name": "Points",
"usageType": "Currency",
"amount": {
"amount": 0.00,
"units": "JMD"
}
},
{
"id": "8",
"@baseType": "BucketBalance",
"name": "Off Net",
"usageType": "mins",
"amount": {
"amount": 14494.64,
"units": "mins"
}
},
{
"id": "11",
"@baseType": "BucketBalance",
"amount": {
"amount": 0.00
}
},
{
"id": "13",
"@baseType": "BucketBalance",
"name": "Double Bubble Bonus",
"usageType": "Currency",
"amount": {
"amount": 0.00,
"units": "JMD"
}
},
{
"id": "1",
"@baseType": "BucketBalance",
"name": "primary balance",
"usageType": "Currency",
"amount": {
"amount": 1.00,
"units": "JMD"
}
}
],
"@type": "AccumulatorHistory"
}
]
}
]