Jump to

• Request
• Response
• Examples

Cancel an Installment Schedule

post

/bcws/webresources/v1.0/installmentManagement/cancelInstallment

Cancels an installment schedule.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json, application/xml

Request Body - application/json, application/xml ()

Root Schema : schema

Type: object

Show Source

• completedAt(required): string
  The completion date and time of the operation.
• createdAt(required): string
  The date of creation.
• customerRef(required): string
  The customer reference.
• error(required): string
  The error message for any details or corrective actions.
• href(required): string
  The unique resource URL, used for getting the object.
• id(required): string
  The ID of the installment schedule to cancel.
• installmentRef(required): string
  The installment schedule reference.
• notes(required): string
  Notes about the cancellation.
• reason(required): string
  The reason for cancellation.
• status(required): string
  The status of the installment schedule cancelation.
  Allowed Values: COMPLETED, FAILED, PENDING

{
    "required":[
        "completedAt",
        "createdAt",
        "customerRef",
        "error",
        "href",
        "id",
        "installmentRef",
        "notes",
        "reason",
        "status"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the installment schedule to cancel."
        },
        "href":{
            "type":"string",
            "description":"The unique resource URL, used for getting the object."
        },
        "createdAt":{
            "type":"string",
            "description":"The date of creation."
        },
        "completedAt":{
            "type":"string",
            "description":"The completion date and time of the operation."
        },
        "status":{
            "type":"string",
            "description":"The status of the installment schedule cancelation.<br/>Allowed Values: COMPLETED, FAILED, PENDING"
        },
        "customerRef":{
            "type":"string",
            "description":"The customer reference."
        },
        "installmentRef":{
            "type":"string",
            "description":"The installment schedule reference."
        },
        "reason":{
            "type":"string",
            "description":"The reason for cancellation."
        },
        "notes":{
            "type":"string",
            "description":"Notes about the cancellation."
        },
        "error":{
            "type":"string",
            "description":"The error message for any details or corrective actions."
        }
    },
    "xml":{
        "name":"cancelInstallment"
    }
}

Back to Top

Response

200 Response

The installment schedule was canceled successfully.

500 Response

An error occurred. An exception has been raised.

Back to Top

Examples

This example shows how to cancel an installment 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/installmentManagement/cancelInstallment' -H 'content-type: application/json' -d @cancelInstallment.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.
• cancelInstallment.json is the JSON file that specifies the installment to cancel.

Example of Request Body

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

{
"customerRef":"0.0.0.1+-account+134849",
"installmentRef": "0.0.0.1+-installment+105622",
"notes":"Canceling installment",
"reason" : "Customer requested cancellation."
}

Example of Response Body

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

{
	"id": "0.0.0.1+-installment+105622",
	"href": "http://hostname:port/bcws/webresources/version/0.0.0.1+-installment+105622"
}

Back to Top