Create a Customer Deposit with Payments

post

/bcws/webresources/v1.0/depositManagement/customerDeposit/order

Creates a customer deposit order with payments.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/xml ()
Root Schema : schema
Type: object
Show Source
Nested Schema : CustomerDeposit
Type: object
Show Source
Nested Schema : payments
Type: array
Show Source
Nested Schema : Money
Type: object
Show Source
Nested Schema : transactions
Type: array
Show Source
Nested Schema : TimePeriod
Type: object
Show Source
Nested Schema : DepositValidityRule
Type: object
Show Source
Nested Schema : CustomerDepositTransactions
Type: object
Show Source
Nested Schema : DepositPayment
Type: object
Show Source
Nested Schema : Discriminator: @class
Type: object
Show Source
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : CustomerDeposit
Type: object
Show Source
Nested Schema : payments
Type: array
Show Source
Nested Schema : Money
Type: object
Show Source
Nested Schema : transactions
Type: array
Show Source
Nested Schema : TimePeriod
Type: object
Show Source
Nested Schema : DepositValidityRule
Type: object
Show Source
Nested Schema : CustomerDepositTransactions
Type: object
Show Source
Nested Schema : DepositPayment
Type: object
Show Source
Nested Schema : Discriminator: @class
Type: object
Show Source
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Back to Top

Response

201 Response

The customer deposit order was created successfully, and the ID of the new deposit was returned.

500 Response

An error occurred. An exception has been raised.
Back to Top

Examples

This example shows how to create a deposit with payments by submitting a POST request on the REST resource using cURL. For more information about cURL, see "Use cURL".

cURL Command

curl -X POST 'http://hostname:port/bcws/webresources/version/depositManagement/customerDeposit/order' -H 'content-type: application/json' -d @createDeposit.json

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.
  • createDeposit.json is the JSON file that specifies the deposit to create.

Example of Request Body

This example shows the contents of the createDeposit.json file sent as the request body.

{  
  "customerDepositRef": "0.0.0.1+-purchased_deposit+2172776+0",
  "refundAmount": {
    "amount": 10,
    "currency": "INR"
  },
  "notes": "Deposit refund request"
}

Example of Response Body

This example shows the contents of the response body in JSON format.

{
    "id": "0.0.0.1+-purchased_deposit+2172776+0",
    "href": "http://hostname:port/bcws/webresources/version/depositManagement/customerDeposit/order/0.0.0.1+-purchased_deposit+2172776+0"
}
Back to Top