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

Get a Batch Payment File by File Name

get

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

Gets the batch payment file that matches the specified file name.

The response contains the contents of the batch payment file in text format.

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

200 Response

The batch payment file was returned successfully.

500 Response

An internal server error occurred.
Back to Top

Examples

This example shows how to get a batch payment file by file name 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/viewfile/{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

This example shows the contents of the response body in JSON format. The response body returns details of the file that is being searched for.
# This file is created by Billing Care.
# Modifying this file is not recommended.
[STATES]
Locale ID,1024
Batch Date,12/may/2023
Batch Total,868.30
Batch ID,T1-23
Lockbox Name,Lockbox 1234
Currency ID,840
Allocation Style,1
Batch Size,1
Batch Name,Cash test Payment Batch
Specified Total,0.00
[GRID DATA]
Status	Allocation	*	Bill Number	Account Number	First Name	Last Name	Due Amount	Receipt Date	Receipt No.	Channel	Suspense Description	Status Description	Status Code	Comment	Payment Amount	ach	batch_id	batch_total	channel_id	lockbox_id	lockbox_t	result	submitter_id
, , , ,Bill,Account,First, ,27-May-2016,1.00
Back to Top