Assign a Handler to Suspended Payment
post
/bcws/webresources/v1.0/payments/suspense/assignhandler
Assigns an authorized handler to manage the suspended payment.
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
The authorized payment handler to assign.
Root Schema : schema
Type:
Show Source
object
-
extension: object
extension
The extended attributes.
-
locale(required): string
The locale of the suspence payment handler, such as en_US or fr_FR. For a list of valid values, see "Locale Names" in BRM Developer's Guide.
-
paymentEventRef: object
ResourceRef
-
userId: integer
(int32)
The user ID of the suspense payment handler.
-
userName(required): string
The user name of the suspense payment handler.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : ResourceRef
Type:
Show Source
object
-
id(required): string
The ID.
-
uri: string
The Uniform Resource Identifier (URI) associated with the resource.
The authorized payment handler to assign.
Root Schema : schema
Type:
Show Source
object
-
extension: object
extension
The extended attributes.
-
locale(required): string
The locale of the suspence payment handler, such as en_US or fr_FR. For a list of valid values, see "Locale Names" in BRM Developer's Guide.
-
paymentEventRef: object
ResourceRef
-
userId: integer
(int32)
The user ID of the suspense payment handler.
-
userName(required): string
The user name of the suspense payment handler.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : ResourceRef
Type:
Show Source
object
-
id(required): string
The ID.
-
uri: string
The Uniform Resource Identifier (URI) associated with the resource.
Response
201 Response
A handler was successfully assigned to the suspended payment.
500 Response
An internal server error occurred.
Examples
This example shows how to assign a handler for a suspended 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/assignhandler' -H 'content-type: application/json' -d @supendedPaymentHandler.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.
- supendedPaymentHandler.json is the JSON file that specifies the handler details.
Example of Request Body
This example shows the contents of the supendedPaymentHandler.json file sent as the request body.
{
"locale": "en_US",
"paymentEventRef": {
"id": "0.0.0.1+-event-billing-payment-cash+328023900984401663"
},
"userName": "HeadCSR"
}
Example of Response Body
If successful, the response code 201 is returned with true in the response body.