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
-
customerDepositRef(required): string
The customer deposit ID, for example: 0.0.0.1+-purchased_deposit+1234567
Query Parameters
-
limit: string
The maximum number of records to be displayed on a page.
-
skip: string
The number of records to skip before returning results.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
201 Response
The deposit transaction details were returned successfully.
Nested Schema : depositTxn
Type:
Show Source
object
-
balanceImpacts(required): array
balanceImpacts
-
createdAt(required): string
The date when the deposit transaction event is created.
-
depositDetails(required): array
depositDetails
-
depositInfo(required): array
depositInfo
-
descr(required): string
The deposit transaction event description.
-
href(required): string
The unique resource URL, used to get the deposit transaction event.
-
id(required): string
The deposit transaction event ID.
-
modifiedAt(required): string
The date when the deposit transaction event is modified.
-
notes(required): array
notes
-
payment: object
DepositTxnPayment
-
quantity: number
The quantity of the deposit transaction event.
-
startsAt(required): string
The start date of the deposit transaction event.
-
systemEvent(required): string
The system event of the deposit transaction event.
-
txnType(required): string
The transaction type of the deposit transaction event.
Nested Schema : DepositTxnPayment
Type:
Show Source
object
-
completedAt(required): string
The date when the deposit payment is completed.
-
createdAt(required): string
The date when the deposit payment is created.
-
customerDepositRef(required): string
The deposit reference.
-
customerRef(required): string
The customer reference.
-
glCode(required): string
The general ledger code for the deposit payment.
-
href(required): string
The unique resource URL, used to get the deposit payment.
-
id(required): string
The deposit payment ID.
-
notes(required): string
The notes for the deposit payment.
-
payinfoTypeObject: object
Discriminator: @class
Discriminator:
{ "propertyName":"@class" }
-
paymentAmount: object
Money
-
paymentId: string
The payment ID for the deposit payments.
-
paymentMethodType: integer
(int32)
The payment method type. Allowed Values:
- 10003 (Credit card)
- 10005 (Direct debit)
- 10011 (Cash)
- 10012 (Check)
- 10013 (Wire Transfer)
- 10014 (Inter-bank payment order)
- 10015 (Postal order)
- 3 (Prepayment)
- 4 (Other)
-
paymentRef(required): string
The payment reference.
-
status: integer
(int32)
The deposit payment transaction status. Allowed Values:
- 1 (Completed)
- 2 (Failed)
- 3 (Pending)
-
transactionId: string
Indicates the transaction ID for the deposit payments.
Nested Schema : DepositTxnBalanceImpacts
Type:
Show Source
object
-
amount: object
Money
-
discountAmount: object
Money
-
resourceId(required): string
The balance impact's resource ID.
-
tax: object
Money
Nested Schema : Money
Type:
Show Source
object
-
amount(required): number
The amount of money.
-
currency: integer
(int32)
The currency for the money.
Nested Schema : DepositTxnDepositDetails
Type:
Show Source
object
-
depositRef(required): string
The deposit reference.
-
destDepositRef(required): string
The destination deposit reference.
-
sourceDepositRef(required): string
The source deposit reference.
Nested Schema : DepositTxnDepositInfo
Type:
Show Source
object
-
amount: object
Money
-
billInfoRef(required): string
The bill reference.
-
customerRef(required): string
The customer reference.
-
dayOfWeek: integer
(int32)
The day of the week.
-
serviceRef(required): string
The service reference.
-
toBillInfoRef(required): string
The bill reference to which the transaction is made.
-
toServiceRef(required): string
The service reference to which the transaction is made.
Nested Schema : DepositTxnNotes
Type:
Show Source
object
-
createdAt(required): string
The date when the deposit transaction note is created.
-
id(required): string
The deposit transaction note ID.
-
modifiedAt(required): string
The date when the deposit transaction note is modified.
-
note(required): string
The deposit transaction note.
Nested Schema : Discriminator: @class
Type:
Show Source
object
-
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.
Nested Schema : ResourceRef
Type:
Show Source
object
-
id(required): string
The ID.
-
uri: string
The Uniform Resource Identifier (URI) associated with the resource.
Nested Schema : extension
Type:
object
The extended attributes.
500 Response
An error occurred. An exception has been raised.
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
}
]
}
}
}
]