Jump to

• Request
• Response
• Examples

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

Request Body - 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.
• 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"
        }
    },
    "xml":{
        "name":"WithdrawPayment"
    }
}

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."
        }
    }
}

Request Body - application/xml ()

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.
• 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"
        }
    },
    "xml":{
        "name":"WithdrawPayment"
    }
}

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."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

201 Response

The posted payment was successfully withdrawn into suspense.

Body ()

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.

Back to Top

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"
    }
}

Back to Top