1. REST API Reference for Billing Care
  2. Tasks
  3. Batch Payments

Check If a Batch File Was Processed

get

/bcws/webresources/v1.0/batchpayments/filecount/{fileName}

Checks if the batch file named filename is already committed to the system. If it's already committed, it returns a count greater than 0.

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

200 Response

If the file was already processed, an integer greater than zero is returned.

500 Response

An internal server error occurred.
Back to Top

Examples

This example shows how to check if a batch file was processed 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/batchpayments/filecount/{fileName}'

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

If the file was already committed to the system a response greater than 0 is returned. For example, 1.

If the file was not committed to the system, the response 0 is returned.

Back to Top