REST API Reference for Billing Care

Deposits REST Endpoints

Deposits

The REST web service for all deposit-related operations.

Cancel a Customer Deposit: Method: post
Path: /bcws/webresources/v1.0/depositManagement/depositReversal
Create a Customer Deposit Payment: Method: post
Path: /bcws/webresources/v1.0/depositManagement/depositPayment
Create a Customer Deposit with Payments: Method: post
Path: /bcws/webresources/v1.0/depositManagement/customerDeposit/order
Create a Deposit Specification: Method: post
Path: /bcws/webresources/v1.0/depositManagement/depositSpec
Create a Deposit Specification Profile: Method: post
Path: /bcws/webresources/v1.0/depositManagement/depositspecprofile
Create an Advice of Charge Customer Deposit: Method: post
Path: /bcws/webresources/v1.0/depositManagement/customerDeposit/chargeofadvice
Delete a Deposit Specification: Method: delete
Path: /bcws/webresources/v1.0/depositManagement/depositSpec/{id}
Get a Customer Deposit by ID: Method: get
Path: /bcws/webresources/v1.0/depositManagement/customerDeposit/{id}
Get a Deposit Refund by ID: Method: get
Path: /bcws/webresources/v1.0/depositManagement/depositRefund/{id}
Get a Deposit Specification by ID: Method: get
Path: /bcws/webresources/v1.0/depositManagement/depositSpec/{id}
Get a Deposit Specification Profile by ID: Method: get
Path: /bcws/webresources/v1.0/depositManagement/depositspecprofile/{id}
Get a Deposit Transaction by ID: Method: get
Path: /bcws/webresources/v1.0/depositManagement/depositTxn/{id}
Get All Packages: Method: get
Path: /bcws/webresources/v1.0/depositManagement/packages
Get Charge Offers: Method: get
Path: /bcws/webresources/v1.0/depositManagement/chargeOffer
Get Customer Deposits: Method: get
Path: /bcws/webresources/v1.0/depositManagement/customerDeposit
Get Deposit Refunds: Method: get
Path: /bcws/webresources/v1.0/depositManagement/depositRefund/search
Get Deposit Specification Profiles: Method: get
Path: /bcws/webresources/v1.0/depositManagement/depositspecprofile
Get Deposit Specifications or Offers: Method: get
Path: /bcws/webresources/v1.0/depositManagement/depositSpec
Get Deposit Transaction by Deposit: Method: get
Path: /bcws/webresources/v1.0/depositManagement/depositTxn/{customerDepositRef}/events
Refund a Customer Deposit: Method: post
Path: /bcws/webresources/v1.0/depositManagement/depositRefund
Release a Customer Deposit: Method: post
Path: /bcws/webresources/v1.0/depositManagement/depositRelease
Transfer a Customer Deposit: Method: post
Path: /bcws/webresources/v1.0/depositManagement/depositTransfer
Update a Customer Deposit: Method: patch
Path: /bcws/webresources/v1.0/depositManagement/customerDeposit/{id}
Update a Deposit Refund Request: Method: patch
Path: /bcws/webresources/v1.0/depositManagement/depositRefund/{id}
Update a Deposit Specification: Method: patch
Path: /bcws/webresources/v1.0/depositManagement/depositSpec/{id}
Update a Deposit Specification Profile: Method: patch
Path: /bcws/webresources/v1.0/depositManagement/depositspecprofile/{id}