Release a Customer Deposit
post
/bcws/webresources/v1.0/depositManagement/depositRelease
Releases a customer deposit.
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
The deposit to release. The minimum required parameters are:
- customerRef
- customerDepositRef
Root Schema : schema
Type:
Show Source
object
-
completedAt(required): string
The deposit release completion date.
-
createdAt(required): string
The date when the deposit release is initiated.
-
customerDepositRef(required): string
The customer deposit reference.
-
customerRef(required): string
The customer reference.
-
error(required): string
Error message for the deposit release.
-
glCode(required): string
The general ledger ID.
-
href(required): string
The unique resource URL, used to get the object.
-
id(required): string
The deposit reference ID.
-
notes(required): string
Notes about the deposit release.
-
reason(required): string
Reason for the deposit release.
-
releaseAmount: object
Money
-
releaseRef(required): string
The deposit release reference.
-
releaseType: integer
(int32)
The deposit release type.
Allowed Values: PREPAYMENT, REFUND -
status(required): string
The deposit release status.
Allowed Values: COMPLETED, FAILED, PENDING, ACCEPTED, REJECTED
Nested Schema : Money
Type:
Show Source
object
-
amount(required): number
The amount of money.
-
currency: integer
(int32)
The currency for the money.
The deposit to release. The minimum required parameters are:
- customerRef
- customerDepositRef
Root Schema : schema
Type:
Show Source
object
-
completedAt(required): string
The deposit release completion date.
-
createdAt(required): string
The date when the deposit release is initiated.
-
customerDepositRef(required): string
The customer deposit reference.
-
customerRef(required): string
The customer reference.
-
error(required): string
Error message for the deposit release.
-
glCode(required): string
The general ledger ID.
-
href(required): string
The unique resource URL, used to get the object.
-
id(required): string
The deposit reference ID.
-
notes(required): string
Notes about the deposit release.
-
reason(required): string
Reason for the deposit release.
-
releaseAmount: object
Money
-
releaseRef(required): string
The deposit release reference.
-
releaseType: integer
(int32)
The deposit release type.
Allowed Values: PREPAYMENT, REFUND -
status(required): string
The deposit release status.
Allowed Values: COMPLETED, FAILED, PENDING, ACCEPTED, REJECTED
Nested Schema : Money
Type:
Show Source
object
-
amount(required): number
The amount of money.
-
currency: integer
(int32)
The currency for the money.
Response
201 Response
The deposit release was created successfully, and the ID of the new deposit release was returned.
500 Response
An error occurred. An exception has been raised.
Examples
This example shows how to release a deposit 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/depositRelease' -H 'content-type: application/json' -d @releaseDeposit.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.
- releaseDeposit.json is the JSON file that specifies the deposit to release.
Example of Request Body
This example shows the contents of the releaseDeposit.json file sent as the request body.
{
"customerDepositRef": "0.0.0.1+-purchased_deposit+2171288+0",
"releaseAmount": {
"amount": 1,
"currency": "INR"
},
"releaseType": "ZEROISE",
"notes": "release deposit"
}
Example of Response Body
This example shows the contents of the response body in JSON format.
{
"id": "0.0.0.1+-purchased_deposit+2171288",
"href": "http://hostname:port/bcws/webresources/version/depositManagement/depositRelease/0.0.0.1+-purchased_deposit+2171288"
}