Get Suspense Accounts
get
/bcws/webresources/v1.0/payments/suspense/accounts
Gets a list of all payment suspense accounts.
Request
There are no request parameters for this operation.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
The list of accounts was returned successfully.
Nested Schema : suspenseAccount
Type:
Show Source
object
-
accountId(required): string
The ID of the account.
-
accountNumber(required): string
The account number.
-
extension: object
extension
The extended attributes.
-
firstName(required): string
The first name of the suspense account..
-
lastName(required): string
The last name of the suspense account.
Nested Schema : extension
Type:
object
The extended attributes.
500 Response
An internal server error occurred.
Examples
This example shows how to get a list of accounts that have suspended payments 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/payments/suspense/accounts'
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.
Example of Response Body
This example shows the contents of the response body in JSON format.
[
{
"extension": null,
"accountId": "0.0.0.1+-account+123217",
"accountNumber": "0.0.0.1-123217",
"firstName": "Anders",
"lastName": "Larsen"
}
]