1. REST API Reference for Billing Care
  2. Tasks
  3. Payments

Allocate a Suspended Payment to an Account

post

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

Allocates a suspended payment to the specified account.

Request

Query Parameters
  • Whether to validate that the account has an open bill that is due. When validate=openBills, it checks if the account has any open due bills. For any other value, validation is skipped.
Supported Media Types
Request Body - application/json ()
Information for allocating the suspended payment. The schema payload should contain the following:
  • The event resource associated with the suspended account
  • The amount to allocate to the target account
  • The target account's currency
  • The total amount to allocate from suspense
  • (Optional) The bill items along with the amount to allocate to each one in case of manual allocation of items
Root Schema : schema
Type: object
Show Source
Nested Schema : details
Type: array
The list of details associated with the recycled payment.
Show Source
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Notes
Type: object
Show Source
Nested Schema : Details
Type: object
The offer details.
Show Source
Nested Schema : comments
Type: array
The list of comments associated with the note.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Comments
Type: object
The list of comments associated with the note.
Show Source
Request Body - application/xml ()
Information for allocating the suspended payment. The schema payload should contain the following:
  • The event resource associated with the suspended account
  • The amount to allocate to the target account
  • The target account's currency
  • The total amount to allocate from suspense
  • (Optional) The bill items along with the amount to allocate to each one in case of manual allocation of items
Root Schema : schema
Type: object
Show Source
Nested Schema : details
Type: array
The list of details associated with the recycled payment.
Show Source
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Notes
Type: object
Show Source
Nested Schema : Details
Type: object
The offer details.
Show Source
Nested Schema : comments
Type: array
The list of comments associated with the note.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Comments
Type: object
The list of comments associated with the note.
Show Source
Back to Top

Response

Supported Media Types

201 Response

The suspended payment was successfully allocated to the account.
Body ()
Root Schema : resource
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : ResourceRef
Type: object
Show Source

400 Response

The request isn't valid.

500 Response

An internal server error occurred.
Back to Top

Examples

This example shows how to allocate a suspended payment to an account 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/allocate' -H 'content-type: application/json' -d @allocateSupendedPayment.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.
  • allocateSupendedPayment.json is the JSON file that specifies the allocation details.

Example of Request Body

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

{
   "eventRef": {
      "id": "0.0.0.1+-event-billing-payment-cash+328270191589064123"
   },
   "details": [
      {
         "accountRef": {
            "id": "0.0.0.1+-account+181438"
         },
         "currency": 840,
         "reasonId": "11",
         "domainId": 5,
         "billItems": [
            {
               "itemRef": {
                  "id": "0.0.0.1+-item-cycle_forward+260691"
               },
               "amount": -50 
            }
         ],
         "totalAmount": 50
      }
   ],
   "unallocatedSuspendedAmount": 50
}

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+328270191589063256",
      "uri": "http://hostname:port/bcws/webresources/v1.0/payments/0.0.0.1+-event-billing-payment-cash+328270191589063256"
   }
}
Back to Top