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

Create a Suspended Payment

post

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

Creates a suspended payment.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Notes
Type: object
Show Source
Nested Schema : Discriminator: @class
Type: object
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
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Back to Top

Response

Supported Media Types

201 Response

The suspended payment was created successfully.
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Notes
Type: object
Show Source
Nested Schema : Discriminator: @class
Type: object
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
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.

500 Response

An internal server error occurred.
Back to Top

Examples

This example shows how to create 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/payment' -H 'content-type: application/json' -d @createSupendedPayment.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.
  • createSupendedPayment.json is the JSON file that specifies the payment details.

Example of Request Body

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

{
   "payinfoTypeObject": {
      "checkInfo": [
         {
            "effectiveDate": "2021-02-02T12:23:08.000Z",
            "checkNo": "checkNumber",
            "bankCode": "bankCode",
            "bankAccountNo": "accountNumber"
         }
      ],
      "@class": "com.oracle.communications.brm.cc.model.Externalpayment10012",
      "accountObj": {
         "id": "0.0.0.1+-account+181438"
      },
      "paymentType": "10012",
      "externalType": true,
      "id": {
         "id": "0.0.0.1+-payinfo+054831"
      }
   },
   "amount": 10,
   "currency": "840",
   "notes": {
      "amount": 10,
      "domainId": 14,
      "reasonId": "2005",
      "status": 101,
      "comments": [
         {
            "comment": "Creating suspended payment."
         }
      ]
   }
}

Example of Response Body

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

{
   "extension": null,
   "payinfoTypeObject": 
      {
         "@class": "com.oracle.communications.brm.cc.model.Externalpayment10012",
         "extension": null,
         "id": {
            "id": "0.0.0.1+-payinfo+0",
            "uri": null
         },
         "creationDate": null,
         "accountObj": {
            "id": "0.0.0.1+-account+181438",
            "uri": null
         },
         "paymentType": 10012,
         "name": null,
         "externalType": true,
         "checkInfo": [
            {
               "effectiveDate": 1612268588000,
               "checkNo": "",
               "bankCode": "",
               "bankAccountNo": "",
               "billNo": null,
               "elem": null
            }
         ]
   },
   "currency": 840,
   "selectedBillUnit": null,
   "itemPaymentRef": "0.0.0.1+-item-payment+260633",
   "amount": 10, 
   "notes": {
      "extension": null,
      "id": "0.0.0.1+-note+258329",
      "accountId": "0.0.0.1+-account-123217",
      "amount": 10,
      "billUnitId": null,
      "billId": null,
      "closedDate": null,
      "count": null,
      "effectiveDate": null,
      "eventId": "0.0.0.1+-event-billing-payment-check+328270191589062169",
      "header": null,
      "itemId": "0.0.0.1+-item-payment+260633",
      "subType": 802,
      "type": 800,
      "domainId": 14,
      "reasonId": 2005,
      "serviceId": null,
      "status": 101,
      "comments": [
         {
            "csrLoginId": "HeadCSR",
            "csrFirstName": "Alia",
            "csrLastName": "Abadi",
            "csrAccountId": "1234",
            "externalUser": "CSR Portal",
            "comment": "Creating suspended payment.",
            "trackingId": null,
            "entryDate": null
         }
      ]
   }
}
Back to Top