Get Deposit Refunds
get
/bcws/webresources/v1.0/depositManagement/depositRefund/search
Gets the deposit refunds that match the query criteria.
Request
Query Parameters
-
customerNo(required): string
The account number, for example: 123
-
customerRef(required): string
The customer ID, for example: 0.0.0.1+-account+123123
-
limit(required): string
The maximum number of records to be displayed on a page.
-
serviceRef(required): string
The service ID, for example: 0.0.0.1+-service+123123
-
status(required): string
The deposit refund status, for example: APPROVE
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
201 Response
The customer deposit refunds were returned successfully.
Nested Schema : schema
Type:
Show Source
object
-
accountNumber(required): string
The account number.
-
approvedRefundAmount: object
Money
-
completedAt(required): string
The deposit refund completion date.
-
createdAt(required): string
The date when the deposit refund is initiated.
-
customerDepositRef(required): string
The customer deposit reference.
-
customerRef(required): string
The customer reference.
-
error(required): string
Error message for the deposit refund.
-
glCode(required): string
The general ledger ID.
-
href(required): string
The unique resource URL, used to get the object.
-
id(required): string
The deposit refund ID.
-
modifiedAt(required): string
The date when the deposit refund is modified.
-
notes(required): string
Notes about the deposit refund.
-
reason(required): string
Reason for the deposit refund.
-
refundAmount: object
Money
-
refundRef(required): string
The deposit refund reference.
-
serviceRef(required): string
The service reference.
-
status: integer
(int32)
The deposit refund status. Allowed Values:
- 0 (Completed)
- 1 (Failed)
- 2 (Pending)
- 3 (Accepted)
- 4 (Rejected)
Nested Schema : Money
Type:
Show Source
object
-
amount(required): number
The amount of money.
-
currency: integer
(int32)
The currency for the money.
500 Response
An error occurred. An exception has been raised.
Examples
This example shows how to get approved deposit refunds for an account 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/depositManagement/depositRefund/search?status=APPROVE&customerRef=0.0.0.1+-account+622970'
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.
[
{
"id": "0.0.0.1+-deposit_refund_request+805939",
"href": "http://hostname:port/bcws/webresources/version/depositManagement/depositRefund/search/0.0.0.1+-deposit_refund_request+805939",
"createdAt": "2021-06-01T13:52:57.000Z",
"modifiedAt": "2021-06-01T13:52:57.000Z",
"status": "APPROVE",
"customerRef": "0.0.0.1+-account+622970",
"serviceRef": "0.0.0.1+-service-telco-gsm+624122",
"customerDepositRef": "0.0.0.1+-purchased_deposit+776737",
"refundAmount": {
"amount": 0
},
"approvedRefundAmount": {
"amount": 0
}
},
{
"id": "0.0.0.1+-deposit_refund_request+1105586",
"href": "http://hostname:port/bcws/webresources/version/depositManagement/depositManagement/depositRefund/0.0.0.1+-deposit_refund_request+1105586",
"createdAt": "2021-06-11T19:54:36.000Z",
"modifiedAt": "2021-06-11T19:54:36.000Z",
"status": "APPROVE",
"customerRef": "0.0.0.1+-account+622970",
"serviceRef": "0.0.0.1+-service-telco-gsm+1008217",
"customerDepositRef": "0.0.0.1+-purchased_deposit+1009113",
"refundAmount": {
"amount": 15
},
"approvedRefundAmount": {
"amount": 0
}
}
]