REST API Reference for Billing Care

Create a Payment

post

/bcws/webresources/v1.0/payments

Creates a payment for the bill units specified in the body.

Request

Query Parameters

savePaymentType(required): boolean
Whether to save the payment method information:
- true specifies to save the payment method information.
- false specifies to make the payment without saving the payment method.

Supported Media Types

application/json

The payment to create. Specifies the target bill unit and the payment amount.

Root Schema : schema

Type: object

Show Source

amount(required): number

The payment amount.
currency: integer (int32)

The payment's currency.
extension: object extension

The extended attributes.
itemPaymentRef: string

The item associated with the payment.
notes: object Notes
payinfoTypeObject: object Discriminator: @class

Discriminator: { "propertyName":"@class" }
selectedBillUnit: string

The bill unit associated with the payment.

{
    "required":[
        "amount"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "payinfoTypeObject":{
            "$ref":"#/components/schemas/PaymentTypeBase"
        },
        "currency":{
            "type":"integer",
            "description":"The payment's currency.",
            "format":"int32"
        },
        "selectedBillUnit":{
            "type":"string",
            "description":"The bill unit associated with the payment."
        },
        "itemPaymentRef":{
            "type":"string",
            "description":"The item associated with the payment."
        },
        "amount":{
            "type":"number",
            "description":"The payment amount."
        },
        "notes":{
            "$ref":"#/components/schemas/Notes"
        }
    },
    "xml":{
        "name":"payment"
    }
}

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 <a href=\"http://docs.oracle.com/pls/topic/lookup?ctx=brm120&id=GUID-D733989B-5B0E-4643-B70A-77B62A73314D\">Localizing and Customizing Strings</a> 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 <a href=\"http://docs.oracle.com/pls/topic/lookup?ctx=brm120&id=GUID-D733989B-5B0E-4643-B70A-77B62A73314D\">Localizing and Customizing Strings</a> 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 <a href=\"http://docs.oracle.com/pls/topic/lookup?ctx=brm120&id=GUID-D733989B-5B0E-4643-B70A-77B62A73314D\">Localizing and Customizing Strings</a> 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 : Discriminator: @class

Type: object

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the payment type was created.",
            "format":"date-time"
        },
        "accountObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "paymentType":{
            "type":"integer",
            "description":"The payment type.",
            "format":"int32"
        },
        "name":{
            "type":"string",
            "description":"The name of the payment type."
        }
    },
    "discriminator":{
        "propertyName":"@class"
    }
}

Show Source

accountObj: object ResourceRef
creationDate: string (date-time)

The date and time the payment type was created.
extension: object extension

The extended attributes.
id: object ResourceRef
name: string

The name of the payment type.
paymentType: integer (int32)

The payment type.

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the payment type was created.",
            "format":"date-time"
        },
        "accountObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "paymentType":{
            "type":"integer",
            "description":"The payment type.",
            "format":"int32"
        },
        "name":{
            "type":"string",
            "description":"The name of the payment type."
        }
    },
    "discriminator":{
        "propertyName":"@class"
    }
}

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

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 : extension

Type: object

The extended attributes.

Response

200 Response

The payment was created successfully.

500 Response

An internal server error occurred.

Examples

This example shows how to create a 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?savePaymentType=false' -H 'content-type: application/json' -d @paymentCreate.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.
paymentCreate.json is the JSON file that specifies the payment to create.

Example of Request Body

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

{
   "payinfoTypeObject": {
      "wireTransferInfo": [
         {
            "effectiveDate": "2021-01-28T13:07:34.000Z",
            "wireTransferId": "wireTransfer",
            "bankCode": "bankCode",
            "bankAccountNo": "accountNumber"
         }
      ],
      "@class": "com.oracle.communications.brm.cc.model.Externalpayment10013",
      "accountObj": {
         "id": "0.0.0.1+-account+81329"
      },
      "paymentType": 10013,
      "externalType": true,
      "id": {
         "id": "0.0.0.1+-payinfo+068934"
      }
   },
   "selectedBillUnit": "0.0.0.1+-billinfo+78769",
   "itemPaymentRef": "0.0.0.1+-account+81329",
   "amount": 1,
   "currency": 840,
   "notes": {
      "amount": 1,
      "domainId": 5,
      "accountId": "0.0.0.1+-account+81329",
      "billUnitId": "0.0.0.1+-billinfo+78769",
      "reasonId": "12",
      "status": 101,
      "comments": [
         {
            "comment": "Customer will call bank to check on status."
         }
      ]
   }
}

Example of Response Body

If successful, the response code 200 is returned with no response body.