Get Unprocessed Batch Payment Files
get
/bcws/webresources/v1.0/batchpayments/unprocessed
Gets all unprocessed batch payment files.
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 unprocessed batch payments was returned successfully.
Root Schema : schema
Type:
Show Source
object
-
currency(required): string
The currency of all payments in the batch payment file.
-
extension: object
extension
The extended attributes.
-
fileCreationDate(required): string
(date-time)
The date and time the batch payment file was created.
-
fileName(required): string
The file name for the batch payment file.
-
fileSize: number
(double)
The size of the batch payment file.
-
institutionName(required): string
The name of the institution that created the batch payment file.
-
lockBoxId(required): string
The lockbox's ID.
-
lockBoxName: string
The lockbox's name.
-
noOfPayments: integer
(int64)
The number of payments in the batch payment file.
-
status: integer
(int32)
The status of the batch payment file. Can be one of the following:
- 1: New
- 2: Format error
- 3: Unknown template
- 4: Processing error
- 5: Threshold exceeded
- 6: Processing
-
templateName(required): string
The template name.
Nested Schema : extension
Type:
object
The extended attributes.
400 Response
The request isn't valid.
500 Response
An internal server error occurred.
Examples
This example shows how to get information about any unprocessed batch payment files 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/unprocessed'
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,
"lockBoxName":null,
"lockBoxId":null,
"institutionName":"Cash Payment Batch",
"templateName":null,
"currency":"840",
"fileName":"samplePmt2.pmt",
"fileCreationDate":1612440698046,
"fileSize":0.578125,
"noOfPayments":1,
"status":1
}
]