REST API Reference for Billing Care

Withdraw a Posted Payment into Suspense

post

/bcws/webresources/v1.0/payments/suspense/withdraw

Withdraws a payment that's already been applied to an account into suspense. This allows you to manually resolve errors in a posted payment.

Request

There are no request parameters for this operation.

Supported Media Types

application/xml
application/json

Root Schema : schema

Type: object

Show Source

domainId: integer (int32)

The reason's domain ID.
effectiveDate(required): string (date-time)

The date and time the payment withdrawal took effect.
extension: object extension

The extended attributes.
notes: object Notes
paymentEventRef: object ResourceRef
reasonId: integer (int32)

The reason ID for the payment withdrawal.
suspenseAccountId(required): string

The ID of the suspended account associated with the withdrawal.

{
    "required":[
        "effectiveDate",
        "suspenseAccountId"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "suspenseAccountId":{
            "type":"string",
            "description":"The ID of the suspended account associated with the withdrawal."
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date and time the payment withdrawal took effect.",
            "format":"date-time"
        },
        "paymentEventRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "domainId":{
            "type":"integer",
            "description":"The reason's domain ID.",
            "format":"int32"
        },
        "reasonId":{
            "type":"integer",
            "description":"The reason ID for the payment withdrawal.",
            "format":"int32"
        },
        "notes":{
            "$ref":"#/components/schemas/Notes"
        }
    },
    "xml":{
        "name":"WithdrawPayment"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : Notes

Type: object

Show Source

accountId(required): string

The ID of the account associated with the note.
amount: number

The amount associated with the note. It can be a payment amount, adjustment amount, or so on.
billId: string

The ID of the bill associated with the note.
billUnitId: string

The ID of the bill unit associated with the note.
closedDate: string (date-time)

The date and time the note was resolved.
comments: array comments

The list of comments associated with the note.
count: integer (int32)

The number of comments associated with the note.
domainId: integer (int32)

The domain ID associated with the note.
effectiveDate: string (date-time)

The date and time the comment was posted.
eventId: string

The ID of the event associated with the note.
extension: object extension

The extended attributes.
header: string

The header associated with the note.
id: string

The ID.
itemId: string

The ID of the item associated with the note.
reasonId: integer (int32)

The reason ID associated with the note. Possible values are stored in /config/reason_code_scope objects. See "Localizing and Customizing Strings" in BRM Developer's Guide for information about how to customize these values using the reasons.locale file.
serviceId: string

The service ID associated with the note.
status: number

The note's status: not set (100), resolved (101), or unresolved (102). The default value is 102.
subType: integer (int32)

The note's subtype. Possible values are stored in the /config/note_type object. See "Localizing and Customizing Strings" in BRM Developer's Guide for information about how to customize these values using the note.locale file.
type: integer (int32)

The note's type. Possible values are stored in the /config/note_type object. See "Localizing and Customizing Strings" in BRM Developer's Guide for information about how to customize these values using the note.locale file.

{
    "required":[
        "accountId"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "accountId":{
            "type":"string",
            "description":"The ID of the account associated with the note."
        },
        "amount":{
            "type":"number",
            "description":"The amount associated with the note. It can be a payment amount, adjustment amount, or so on."
        },
        "billUnitId":{
            "type":"string",
            "description":"The ID of the bill unit associated with the note."
        },
        "billId":{
            "type":"string",
            "description":"The ID of the bill associated with the note."
        },
        "closedDate":{
            "type":"string",
            "description":"The date and time the note was resolved.",
            "format":"date-time"
        },
        "count":{
            "type":"integer",
            "description":"The number of comments associated with the note.",
            "format":"int32"
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date and time the comment was posted.",
            "format":"date-time"
        },
        "eventId":{
            "type":"string",
            "description":"The ID of the event associated with the note."
        },
        "header":{
            "type":"string",
            "description":"The header associated with the note."
        },
        "itemId":{
            "type":"string",
            "description":"The ID of the item associated with the note."
        },
        "subType":{
            "type":"integer",
            "description":"The note's subtype. Possible values are stored in the <b>/config/note_type</b> object. See &quot;Localizing and Customizing Strings&quot; in <i>BRM Developer's Guide</i> for information about how to customize these values using the <b>note.</b><i>locale</i> file.",
            "format":"int32"
        },
        "type":{
            "type":"integer",
            "description":"The note's type. Possible values are stored in the <b>/config/note_type</b> object. See &quot;Localizing and Customizing Strings&quot; in <i>BRM Developer's Guide</i> for information about how to customize these values using the <b>note.</b><i>locale</i> file.",
            "format":"int32"
        },
        "domainId":{
            "type":"integer",
            "description":"The domain ID associated with the note.",
            "format":"int32"
        },
        "reasonId":{
            "type":"integer",
            "description":"The reason ID associated with the note. Possible values are stored in <b>/config/reason_code_scope</b> objects. See &quot;Localizing and Customizing Strings&quot; in <i>BRM Developer's Guide</i> for information about how to customize these values using the <b>reasons.</b><i>locale</i> file.",
            "format":"int32"
        },
        "serviceId":{
            "type":"string",
            "description":"The service ID associated with the note."
        },
        "status":{
            "type":"number",
            "description":"The note's status: not set (<b>100</b>), resolved (<b>101</b>), or unresolved (<b>102</b>). The default value is <b>102</b>."
        },
        "comments":{
            "type":"array",
            "description":"The list of comments associated with the note.",
            "items":{
                "$ref":"#/components/schemas/Comments"
            }
        }
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

id(required): string

The ID.
uri: string

The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

Nested Schema : comments

Type: array

The list of comments associated with the note.

Show Source

Array of: object Comments

The list of comments associated with the note.

{
    "type":"array",
    "description":"The list of comments associated with the note.",
    "items":{
        "$ref":"#/components/schemas/Comments"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : Comments

Type: object

The list of comments associated with the note.

Show Source

comment(required): string

The comment.
csrAccountId: string

The CSR's account ID.
csrFirstName: string

The CSR's first name.
csrLastName: string

The CSR's last name.
csrLoginId: string

The login ID associated with the CSR.
entryDate: string (date-time)

The date and time the comment was entered by the CSR.
externalUser: string

The external user.
trackingId: string

The tracking ID.

{
    "required":[
        "comment"
    ],
    "type":"object",
    "properties":{
        "csrLoginId":{
            "type":"string",
            "description":"The login ID associated with the CSR."
        },
        "csrFirstName":{
            "type":"string",
            "description":"The CSR's first name."
        },
        "csrLastName":{
            "type":"string",
            "description":"The CSR's last name."
        },
        "csrAccountId":{
            "type":"string",
            "description":"The CSR's account ID."
        },
        "externalUser":{
            "type":"string",
            "description":"The external user."
        },
        "comment":{
            "type":"string",
            "description":"The comment."
        },
        "trackingId":{
            "type":"string",
            "description":"The tracking ID."
        },
        "entryDate":{
            "type":"string",
            "description":"The date and time the comment was entered by the CSR.",
            "format":"date-time"
        }
    },
    "description":"The list of comments associated with the note."
}

Root Schema : schema

Type: object

Show Source

domainId: integer (int32)

The reason's domain ID.
effectiveDate(required): string (date-time)

The date and time the payment withdrawal took effect.
extension: object extension

The extended attributes.
notes: object Notes
paymentEventRef: object ResourceRef
reasonId: integer (int32)

The reason ID for the payment withdrawal.
suspenseAccountId(required): string

The ID of the suspended account associated with the withdrawal.

{
    "required":[
        "effectiveDate",
        "suspenseAccountId"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "suspenseAccountId":{
            "type":"string",
            "description":"The ID of the suspended account associated with the withdrawal."
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date and time the payment withdrawal took effect.",
            "format":"date-time"
        },
        "paymentEventRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "domainId":{
            "type":"integer",
            "description":"The reason's domain ID.",
            "format":"int32"
        },
        "reasonId":{
            "type":"integer",
            "description":"The reason ID for the payment withdrawal.",
            "format":"int32"
        },
        "notes":{
            "$ref":"#/components/schemas/Notes"
        }
    },
    "xml":{
        "name":"WithdrawPayment"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : Notes

Type: object

Show Source

accountId(required): string

The ID of the account associated with the note.
amount: number

The amount associated with the note. It can be a payment amount, adjustment amount, or so on.
billId: string

The ID of the bill associated with the note.
billUnitId: string

The ID of the bill unit associated with the note.
closedDate: string (date-time)

The date and time the note was resolved.
comments: array comments

The list of comments associated with the note.
count: integer (int32)

The number of comments associated with the note.
domainId: integer (int32)

The domain ID associated with the note.
effectiveDate: string (date-time)

The date and time the comment was posted.
eventId: string

The ID of the event associated with the note.
extension: object extension

The extended attributes.
header: string

The header associated with the note.
id: string

The ID.
itemId: string

The ID of the item associated with the note.
reasonId: integer (int32)

The reason ID associated with the note. Possible values are stored in /config/reason_code_scope objects. See "Localizing and Customizing Strings" in BRM Developer's Guide for information about how to customize these values using the reasons.locale file.
serviceId: string

The service ID associated with the note.
status: number

The note's status: not set (100), resolved (101), or unresolved (102). The default value is 102.
subType: integer (int32)

The note's subtype. Possible values are stored in the /config/note_type object. See "Localizing and Customizing Strings" in BRM Developer's Guide for information about how to customize these values using the note.locale file.
type: integer (int32)

The note's type. Possible values are stored in the /config/note_type object. See "Localizing and Customizing Strings" in BRM Developer's Guide for information about how to customize these values using the note.locale file.

{
    "required":[
        "accountId"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "accountId":{
            "type":"string",
            "description":"The ID of the account associated with the note."
        },
        "amount":{
            "type":"number",
            "description":"The amount associated with the note. It can be a payment amount, adjustment amount, or so on."
        },
        "billUnitId":{
            "type":"string",
            "description":"The ID of the bill unit associated with the note."
        },
        "billId":{
            "type":"string",
            "description":"The ID of the bill associated with the note."
        },
        "closedDate":{
            "type":"string",
            "description":"The date and time the note was resolved.",
            "format":"date-time"
        },
        "count":{
            "type":"integer",
            "description":"The number of comments associated with the note.",
            "format":"int32"
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date and time the comment was posted.",
            "format":"date-time"
        },
        "eventId":{
            "type":"string",
            "description":"The ID of the event associated with the note."
        },
        "header":{
            "type":"string",
            "description":"The header associated with the note."
        },
        "itemId":{
            "type":"string",
            "description":"The ID of the item associated with the note."
        },
        "subType":{
            "type":"integer",
            "description":"The note's subtype. Possible values are stored in the <b>/config/note_type</b> object. See &quot;Localizing and Customizing Strings&quot; in <i>BRM Developer's Guide</i> for information about how to customize these values using the <b>note.</b><i>locale</i> file.",
            "format":"int32"
        },
        "type":{
            "type":"integer",
            "description":"The note's type. Possible values are stored in the <b>/config/note_type</b> object. See &quot;Localizing and Customizing Strings&quot; in <i>BRM Developer's Guide</i> for information about how to customize these values using the <b>note.</b><i>locale</i> file.",
            "format":"int32"
        },
        "domainId":{
            "type":"integer",
            "description":"The domain ID associated with the note.",
            "format":"int32"
        },
        "reasonId":{
            "type":"integer",
            "description":"The reason ID associated with the note. Possible values are stored in <b>/config/reason_code_scope</b> objects. See &quot;Localizing and Customizing Strings&quot; in <i>BRM Developer's Guide</i> for information about how to customize these values using the <b>reasons.</b><i>locale</i> file.",
            "format":"int32"
        },
        "serviceId":{
            "type":"string",
            "description":"The service ID associated with the note."
        },
        "status":{
            "type":"number",
            "description":"The note's status: not set (<b>100</b>), resolved (<b>101</b>), or unresolved (<b>102</b>). The default value is <b>102</b>."
        },
        "comments":{
            "type":"array",
            "description":"The list of comments associated with the note.",
            "items":{
                "$ref":"#/components/schemas/Comments"
            }
        }
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

id(required): string

The ID.
uri: string

The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

Nested Schema : comments

Type: array

The list of comments associated with the note.

Show Source

Array of: object Comments

The list of comments associated with the note.

{
    "type":"array",
    "description":"The list of comments associated with the note.",
    "items":{
        "$ref":"#/components/schemas/Comments"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : Comments

Type: object

The list of comments associated with the note.

Show Source

comment(required): string

The comment.
csrAccountId: string

The CSR's account ID.
csrFirstName: string

The CSR's first name.
csrLastName: string

The CSR's last name.
csrLoginId: string

The login ID associated with the CSR.
entryDate: string (date-time)

The date and time the comment was entered by the CSR.
externalUser: string

The external user.
trackingId: string

The tracking ID.

{
    "required":[
        "comment"
    ],
    "type":"object",
    "properties":{
        "csrLoginId":{
            "type":"string",
            "description":"The login ID associated with the CSR."
        },
        "csrFirstName":{
            "type":"string",
            "description":"The CSR's first name."
        },
        "csrLastName":{
            "type":"string",
            "description":"The CSR's last name."
        },
        "csrAccountId":{
            "type":"string",
            "description":"The CSR's account ID."
        },
        "externalUser":{
            "type":"string",
            "description":"The external user."
        },
        "comment":{
            "type":"string",
            "description":"The comment."
        },
        "trackingId":{
            "type":"string",
            "description":"The tracking ID."
        },
        "entryDate":{
            "type":"string",
            "description":"The date and time the comment was entered by the CSR.",
            "format":"date-time"
        }
    },
    "description":"The list of comments associated with the note."
}

Response

Supported Media Types

application/xml
application/json

201 Response

The posted payment was successfully withdrawn into suspense.

Root Schema : resource

Type: object

Show Source

extension: object extension

The extended attributes.
reference(required): object ResourceRef

{
    "required":[
        "reference"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "reference":{
            "$ref":"#/components/schemas/ResourceRef"
        }
    },
    "xml":{
        "name":"resource"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : ResourceRef

Type: object

Show Source

id(required): string

The ID.
uri: string

The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

400 Response

The request isn't valid.

500 Response

An internal server error occurred.

Examples

This example shows how to withdraw and suspend a posted payment 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/payments/suspense/withdraw' -H 'content-type: application/json' -d @paymentWithdraw.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.
paymentWithdraw.json is the JSON file that specifies the payment details.

Example of Request Body

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

{
    "paymentEventRef": {
        "id": "0.0.0.1+-event-billing-payment-cash+323836960705740624"
    },
    "domainId": 14,
    "reasonId": "2005",
    "suspenseAccountId": null
}

Example of Response Body

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

{
    "extension": null,
    "reference": {
        "id": "0.0.0.1+-event-billing-payment-cash+328270191589057467",
        "uri": "http://hostname:port/bcws/webresources/v1.0/payments/0.0.0.1+-event-billing-payment-cash+328270191589057467"
    }
}