REST API Reference for Billing Care

Cancel a Customer Deposit

post

/bcws/webresources/v1.0/depositManagement/depositReversal

Cancels a customer deposit.

Request

There are no request parameters for this operation.

Supported Media Types

application/xml
application/json

The deposit to cancel. The minimum required parameters are:

customerRef
customerDepositRef

Root Schema : schema

Type: object

Show Source

completedAt(required): string (date-time)

The deposit reversal completion date.
createdAt(required): string (date-time)

The date when the deposit reversal is initiated.
customerDepositRef(required): string

The customer deposit reference.
customerRef(required): string

The customer reference.
error(required): string

Error message for the deposit reversal.
href(required): string

The unique resource URL, used to get the object.
id(required): string

The deposit reversal ID.
notes(required): string

Notes about the deposit reversal.
reason(required): string

Reason for the deposit reversal.
status(required): string

The deposit reversal status.
Allowed Values: COMPLETED, FAILED, PENDING, ACCEPTED, REJECTED

{
    "required":[
        "completedAt",
        "createdAt",
        "customerDepositRef",
        "customerRef",
        "error",
        "href",
        "id",
        "notes",
        "reason",
        "status"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The deposit reversal ID."
        },
        "href":{
            "type":"string",
            "description":"The unique resource URL, used to get the object."
        },
        "customerRef":{
            "type":"string",
            "description":"The customer reference."
        },
        "customerDepositRef":{
            "type":"string",
            "description":"The customer deposit reference."
        },
        "notes":{
            "type":"string",
            "description":"Notes about the deposit reversal."
        },
        "createdAt":{
            "type":"string",
            "description":"The date when the deposit reversal is initiated.",
            "format":"date-time"
        },
        "completedAt":{
            "type":"string",
            "description":"The deposit reversal completion date.",
            "format":"date-time"
        },
        "status":{
            "type":"string",
            "description":"The deposit reversal status.<br/>Allowed Values: COMPLETED, FAILED, PENDING, ACCEPTED, REJECTED"
        },
        "reason":{
            "type":"string",
            "description":"Reason for the deposit reversal."
        },
        "error":{
            "type":"string",
            "description":"Error message for the deposit reversal."
        }
    },
    "xml":{
        "name":"depositReversal"
    }
}

The deposit to cancel. The minimum required parameters are:

customerRef
customerDepositRef

Root Schema : schema

Type: object

Show Source

completedAt(required): string (date-time)

The deposit reversal completion date.
createdAt(required): string (date-time)

The date when the deposit reversal is initiated.
customerDepositRef(required): string

The customer deposit reference.
customerRef(required): string

The customer reference.
error(required): string

Error message for the deposit reversal.
href(required): string

The unique resource URL, used to get the object.
id(required): string

The deposit reversal ID.
notes(required): string

Notes about the deposit reversal.
reason(required): string

Reason for the deposit reversal.
status(required): string

The deposit reversal status.
Allowed Values: COMPLETED, FAILED, PENDING, ACCEPTED, REJECTED

{
    "required":[
        "completedAt",
        "createdAt",
        "customerDepositRef",
        "customerRef",
        "error",
        "href",
        "id",
        "notes",
        "reason",
        "status"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The deposit reversal ID."
        },
        "href":{
            "type":"string",
            "description":"The unique resource URL, used to get the object."
        },
        "customerRef":{
            "type":"string",
            "description":"The customer reference."
        },
        "customerDepositRef":{
            "type":"string",
            "description":"The customer deposit reference."
        },
        "notes":{
            "type":"string",
            "description":"Notes about the deposit reversal."
        },
        "createdAt":{
            "type":"string",
            "description":"The date when the deposit reversal is initiated.",
            "format":"date-time"
        },
        "completedAt":{
            "type":"string",
            "description":"The deposit reversal completion date.",
            "format":"date-time"
        },
        "status":{
            "type":"string",
            "description":"The deposit reversal status.<br/>Allowed Values: COMPLETED, FAILED, PENDING, ACCEPTED, REJECTED"
        },
        "reason":{
            "type":"string",
            "description":"Reason for the deposit reversal."
        },
        "error":{
            "type":"string",
            "description":"Error message for the deposit reversal."
        }
    },
    "xml":{
        "name":"depositReversal"
    }
}

Response

201 Response

The deposit was canceled successfully, and the ID of the deposit reversal (cancellation) was returned.

500 Response

An error occurred. An exception has been raised.

Examples

This example shows how to cancel 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/depositReversal' -H 'content-type: application/json' -d @cancelDeposit.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.
cancelDeposit.json is the JSON file that specifies the deposit to cancel.

Example of Request Body

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

{
    "customerDepositRef": "0.0.0.1+-purchased_deposit+2635314",
    "customerRef": "0.0.0.1+-account+2269345",
    "notes": "Reversing a Deposit"
}

Example of Response Body

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

{
    "id": "0.0.0.1+-purchased_deposit+2635314",
    "href": "http://hostname:port/bcws/webresources/version/depositManagement/depositReversal/0.0.0.1+-purchased_deposit+2635314"
}