Start or Stop Automatic Batch Payments
post
/bcws/webresources/v1.0/batchpayments/autoprocess/{autoProcess}
Starts or stops the automatic batch payment process.
Request
Path Parameters
-
autoProcess(required): boolean
Whether to start the automatic batch payment process (true) or stop the automatic batch payment process (false).
There's no request body for this operation.
Back to TopResponse
201 Response
The batch payment process was started or stopped successfully.
500 Response
An internal server error occurred.
Examples
This example shows how to start or stop automatic batch payments by submitting a POST request on the REST resource using cURL. For more information about cURL, see "Use cURL".
cURL Command
curl -X POST 'http://hostname:port/bcws/webresources/version/batchpayments/autoprocess/{boolean}'
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.
- boolean is the boolean value for the autoprocess, such as true.
You could provide an account ID in the path instead of a service ID to add a bundle at the account level.
Example of Request Body
There is no request body for this operation.
Example of Response Body
If successful, the response code 201 is returned with the boolean value of whether the batch payment auto process was successfully changed or not, such as true or false.