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

Get Details for a Payment

get

/bcws/webresources/v1.0/payments/{id}

Gets the details about a payment.

Request

Path Parameters
  • The ID of the payment or reversal to get, such as 0.0.0.1+-item-payment+123456789732590266.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The payment details were returned successfully.
Body ()
Root Schema : paymentDetails
Type: object
Show Source
Nested Schema : billDetails
Type: array
The list of bill details associated with the payment.
Show Source
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : notes
Type: array
Show Source
Nested Schema : OriginalPaymentDetails
Type: object
Show Source
Nested Schema : Discriminator: @class
Type: object
Show Source
Nested Schema : paymentAuditDetails
Type: array
Show Source
Nested Schema : refundedDetails
Type: array
Show Source
Nested Schema : BillDetails
Type: object
The list of bill details associated with the payment.
Show Source
Nested Schema : itemsAffected
Type: array
Affected bill items.
Show Source
Nested Schema : ItemsAffected
Type: object
Affected bill items.
Show Source
Nested Schema : Notes
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 : extension
Type: object
The extended attributes.
Nested Schema : PaymentAuditDetailsType
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : RefundedDetails
Type: object
Show Source

500 Response

An internal server error occurred.
Back to Top

Examples

This example shows how to get a payment's details by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Use cURL".

cURL Command

curl -X GET 'http://hostname:port/bcws/webresources/version/payments/0.0.0.1+-item-payment+119786'

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.

Example of Response Body

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

{
    "extension": null,
    "originalPaymentAmount": -200,
    "allocatedAmount": 0,
    "unallocatedAmount": -200,
    "currencyId": 840,
    "receiptDate": 1585787580000,
    "postedDate": 1585787580000,
    "paymentType": 10013,
    "paymentAction": null,
    "paymentId": "P1-66",
    "transactionId": "RG20200000009699",
    "subTransactionId": "",
    "eventRef": {
        "id": "0.0.0.1+-event-billing-payment-wtransfer+322869390473288682",
        "uri": null
    },
    "notes": [
        {
            "extension": null,
            "id": "0.0.0.1+-note+123110",
            "accountId": "0.0.0.1+-account+123217",
            "amount": 0,
            "billUnitId": "0.0.0.0++0",
            "billId": null,
            "closedDate": 0,
            "count": 3,
            "effectiveDate": 1594713029000,
            "eventId": "0.0.0.0++0",
            "header": "",
            "itemId": "0.0.0.1+-item-payment+119786",
            "subType": 802,
            "type": 800,
            "domainId": 14,
            "reasonId": 0,
            "serviceId": "0.0.0.0++0",
            "status": 102,
            "comments": [
                {
                    "csrLoginId": "HeadCSR",
                    "csrFirstName": "Alia",
                    "csrLastName": "Abadi",
                    "csrAccountId": "CSR1234",
                    "externalUser": "weblogic",
                    "comment": "Customer called to confirm we received payment.",
                    "trackingId": "",
                    "entryDate": 1594713029000
                }
            ]
        }
    ],
    "accountId": "0.0.0.1+-account+123217",
    "reversalId": null,
    "reversalAmount": null,
    "reversalDate": null,
    "payinfoTypeObject": {
        "@class": "com.oracle.communications.brm.cc.model.Externalpayment10013",
        "extension": null,
        "id": null,
        "creationDate": null,
        "accountObj": null,
        "paymentType": null,
        "name": null,
        "externalType": false,
        "wireTransferInfo": [
            {
                "effectiveDate": 0,
                "wireTransferId": "33787300000009",
                "bankCode": "2B420",
                "bankAccountNo": "160010",
                "elem": null
            }
        ]
    },
    "originalPaymentDetails": {
        "paymentId": "0.0.0.1+-item-payment+119786",
        "accountId": "0.0.0.1+-account+123217",
        "paymentItemNumber": ""
    },
    "billDetails": [
        {
            "billId": "B1-2",
            "cycleStarts": 1589190400000,
            "cycleEnds": 1589446445000,
            "dueAmount": -200,
            "dueDate": 1590641967000,
            "eventsAffectedCount": 0,
            "itemsAffectedCount": 1,
            "itemsAffected": [
                {
                    "accountNumber": "0.0.0.1-57615",
                    "billNumber": "B1-2",
                    "amount": -200,
                    "item": "Cycle forward,B1-2,3",
                    "billUnitName": "Bill Unit(1)",
                    "cycleStarts": 1589180400000,
                    "cycleEnds": 1589446645000,
                    "settledTaxAmount": 20, 
                    "settledTaxedAmount": 200, 
                    "settledNonTaxedAmount": 0
                }
            ]
    "paymentAuditDetails": [
        {
            "extension": null,
            "paymentTypeEventRef": {
                "id": "0.0.0.1+-event-billing-payment-wtransfer+322869390473288682",
                "uri": null
            },
            "activityDate": 1585787580000,
            "accountRef": {
                "id": "0.0.0.1+-account+123217",
                "uri": null
            },
            "paymentItemRef": {
                "id": "0.0.0.1+-item-payment+119786",
                "uri": null
            },
            "accountNumber": "",
            "firstName": null,
            "lastName": null,
            "amount": 200,
            "status": 15,
            "transactionId": "RG20200000009699",
            "subTransactionId": "",
            "csrLoginId": null,
            "domainId": 14,
            "reasonId": 2001
        }
    ]
}
Back to Top