REST API Reference for Billing Care

Batch Payments REST Endpoints

Batch Payments

The REST web service for batch payment, refund, and reversal operations.

Check If a Batch File Was Processed: Method: get
Path: /bcws/webresources/v1.0/batchpayments/filecount/{fileName}
Create a Batch Template: Method: post
Path: /bcws/webresources/v1.0/batchpayments/batchtemplates
Delete a Batch Template: Method: delete
Path: /bcws/webresources/v1.0/batchpayments/batchtemplates/{id}
Get a Batch Payment File by File Name: Method: get
Path: /bcws/webresources/v1.0/batchpayments/viewfile/{fileName}
Get a Batch Template by Template ID: Method: get
Path: /bcws/webresources/v1.0/batchpayments/batchtemplates/{id}
Get Batch Payment Files: Method: get
Path: /bcws/webresources/v1.0/batchpayments/poll
Get Batch Payment Templates: Method: get
Path: /bcws/webresources/v1.0/batchpayments/templates
Get Batch Templates: Method: get
Path: /bcws/webresources/v1.0/batchpayments/batchtemplates
Get Unprocessed Batch Payment Files: Method: get
Path: /bcws/webresources/v1.0/batchpayments/unprocessed
Process Batch Payments: Method: post
Path: /bcws/webresources/v1.0/batchpayments/process
Start or Stop Automatic Batch Payments: Method: post
Path: /bcws/webresources/v1.0/batchpayments/autoprocess/{autoProcess}
Submit a Payment Batch: Method: post
Path: /bcws/webresources/v1.0/batchpayments/submit
Submit a Refund Batch: Method: post
Path: /bcws/webresources/v1.0/batchrefund/submit
Submit a Reversal Batch: Method: post
Path: /bcws/webresources/v1.0/batchreversal/submit
Update a Batch Template: Method: put
Path: /bcws/webresources/v1.0/batchpayments/batchtemplates/{id}
Upload a Batch Payment File: Method: post
Path: /bcws/webresources/v1.0/batchpayments/upload
Validate a Payment Batch: Method: post
Path: /bcws/webresources/v1.0/batchpayments/validate
Validate a Refund Batch: Method: post
Path: /bcws/webresources/v1.0/batchrefund/validate
Validate a Reversal Batch: Method: post
Path: /bcws/webresources/v1.0/batchreversal/validate