Get Deposit Transaction by Deposit

get

/bcws/webresources/v1.0/depositManagement/depositTxn/{customerDepositRef}/events

Gets all of the transactions for a deposit

Request

Path Parameters
Query Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

201 Response

The deposit transaction details were returned successfully.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : depositTxn
Type: object
Show Source
Nested Schema : balanceImpacts
Type: array
Show Source
Nested Schema : depositDetails
Type: array
Show Source
Nested Schema : depositInfo
Type: array
Show Source
Nested Schema : notes
Type: array
Show Source
Nested Schema : DepositTxnPayment
Type: object
Show Source
Nested Schema : DepositTxnBalanceImpacts
Type: object
Show Source
Nested Schema : Money
Type: object
Show Source
Nested Schema : DepositTxnDepositDetails
Type: object
Show Source
Nested Schema : DepositTxnDepositInfo
Type: object
Show Source
Nested Schema : DepositTxnNotes
Type: object
Show Source
Nested Schema : Discriminator: @class
Type: object
Show Source
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.

500 Response

An error occurred. An exception has been raised.
Back to Top

Examples

This example shows how to get a deposit transaction 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/depositManagement/depositTxn/0.0.0.1+-purchased_deposit+219877/events'

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.

[
    {
        "id": "0.0.0.1+-event-billing-deposit-reversal+353057581725607034",
        "href": hostname,
        "createdAt": "2024-12-12T12:53:12.000Z",
        "modifiedAt": "2024-12-12T12:53:12.000Z",
        "startsAt": null,
        "txnType": "Deposit Reversal",
        "quantity": 0,
        "descr": "",
        "systemEvent": null,
        "notes": [
            {
                "id": null,
                "note": "reversing",
                "createdAt": null,
                "modifiedAt": null
            }
        ],
        "depositInfo": [],
        "depositDetails": [],
        "balanceImpacts": [
            {
                "resourceId": "840",
                "tax": null,
                "amount": {
                    "amount": -2150,
                    "currency": null
                },
                "discountAmount": {
                    "amount": 0,
                    "currency": null
                }
            }
        ],
        "payment": null
    },
    {
        "id": "0.0.0.1+-event-billing-payment-cash+353585347306936549",
        "href": "hostname",
        "createdAt": "2025-01-11T08:22:46.000Z",
        "modifiedAt": "2025-01-11T08:22:46.000Z",
        "startsAt": null,
        "txnType": "Deposit Payment",
        "quantity": 0,
        "descr": "",
        "systemEvent": null,
        "notes": [],
        "depositInfo": [],
        "depositDetails": [],
        "balanceImpacts": [
            {
                "resourceId": "840",
                "tax": null,
                "amount": {
                    "amount": -2150,
                    "currency": null
                },
                "discountAmount": {
                    "amount": 0,
                    "currency": null
                }
            }
        ],
        "payment": {
            "id": "0.0.0.1+-event-billing-payment-cash+353585347306936549",
            "href": null,
            "createdAt": "2025-01-11T08:22:46.000Z",
            "completedAt": "2025-01-11T08:22:46.000Z",
            "status": 0,
            "paymentAmount": {
                "amount": 2150,
                "currency": null
            },
            "customerRef": "0.0.0.1+-account+204825",
            "customerDepositRef": null,
            "notes": null,
            "paymentMethodType": 10011,
            "paymentRef": "",
            "glCode": null,
            "transactionId": "T1,e6,0",
            "paymentId": "P1-215",
            "payinfoTypeObject": {
                "@class": "com.oracle.ur1",
                "extension": null,
                "id": null,
                "creationDate": null,
                "accountObj": {
                    "id": "0.0.0.1+-account+204825",
                    "uri": null
                },
                "paymentType": 10011,
                "name": null,
                "externalType": false,
                "cashInfo": [
                    {
                        "effectiveDate": 1736583766000,
                        "receiptNo": "",
                        "billNo": "",
                        "elem": null
                    }
                ]
            }
        }
    }
]
Back to Top