Account Management Biz Api
GET-billingAccountByService
/billingAccount/service [GET]
Key Considerations for PA:
- This operation retrieves a billingAccount entity by passing the service number.
- payload[0].id refers to the AccountNumber in the response.
URL
https://[host]:[port]/tmf-api/accountManagement/v4/{businessId}/billingAccount/serviceURI 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 |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. Minimum characters: 5 | Y |
| client_secret | string | Password associated with the client_id. Minimum characters: 5 | Y |
| 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. | Y |
| lob | string | The Line of Business Identifier currently available are: FIXED POSTPAID | N |
Query Param
| name | type | description | required |
|---|---|---|---|
| serviceNum | string | service Number | Y |
Response
In this section all the possible data structures received by the client at the moment of responding the method are defined.
[ 200 ]
OK - retrieveBillingAccount request processed successfully, response body contains an entity corresponding to the requested resource.
Note: Please refer sample examples for all usecases in raml.