GET Api/BillingAccount?CustomerToken={CustomerToken}&ReferenceNumber={ReferenceNumber}&OtherData={OtherData}
Return Billing Account for the specified Reference Number and Other Data
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| CustomerToken |
Contains the unique customer token used to identify the customer. Optional for CSR. The customer token must be URL encoded. |
string |
String length: inclusive between 0 and 100 |
| OtherData |
Other data of the billing account. Conditionally required to identify Billing Account when the biller uses non-unique account numbers. |
string |
String length: inclusive between 0 and 256 |
| ReferenceNumber |
Reference Number of the billing account. Required to identify Billing Account. |
string |
Required String length: inclusive between 0 and 256 |
Body Parameters
None.
Response Information
Resource Description
Return Billing Account for the specified Reference Number and Other Data
APIBillingAccountResponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ErrorCode |
Name of the error condition. See ErrorCode model for details. |
ErrorCode |
None. |
| ErrorID |
Internal error identification number that uniquely identifies this specific error that occurred. |
string |
None. |
| ErrorNum |
Numeric value of the ErrorCode |
int |
None. |
| Errors |
List of errors that occurred when performing the fdi request. |
Collection of string |
None. |
| Result |
On success contains the requested Billing Account object model. See BillingAccountModel for details. |
BillingAccountModel |
None. |
| Success |
Indicates success or failure of the REST request. |
boolean |
None. |
Response Formats
application/json, text/json
{
"ErrorCode": "None",
"ErrorID": "sample string 1",
"ErrorNum": 0,
"Errors": [
"sample string 1",
"sample string 2"
],
"Result": {
"OtherData": "sample string 2",
"ReferenceNumber": "sample string 3"
},
"Success": true
}