Jump to

• Request
• Response
• Examples

Get a Deposit Transaction by ID

get

/bcws/webresources/v1.0/depositManagement/depositTxn/{id}

Gets the specified deposit transaction.

Request

Path Parameters

• id(required): string
  The deposit transaction ID, for example: 0.0.0.1+-event-billing-payment-cash+123456789123456789

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The deposit transaction details were returned successfully.

Body ()

Root Schema : depositTxn

Type: object

Show Source

• 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.

{
    "required":[
        "balanceImpacts",
        "createdAt",
        "depositDetails",
        "depositInfo",
        "descr",
        "href",
        "id",
        "modifiedAt",
        "notes",
        "startsAt",
        "systemEvent",
        "txnType"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The deposit transaction event ID."
        },
        "href":{
            "type":"string",
            "description":"The unique resource URL, used to get the deposit transaction event."
        },
        "createdAt":{
            "type":"string",
            "description":"The date when the deposit transaction event is created."
        },
        "modifiedAt":{
            "type":"string",
            "description":"The date when the deposit transaction event is modified."
        },
        "startsAt":{
            "type":"string",
            "description":"The start date of the deposit transaction event."
        },
        "txnType":{
            "type":"string",
            "description":"The transaction type of the deposit transaction event."
        },
        "quantity":{
            "type":"number",
            "description":"The quantity of the deposit transaction event."
        },
        "descr":{
            "type":"string",
            "description":"The deposit transaction event description."
        },
        "systemEvent":{
            "type":"string",
            "description":"The system event of the deposit transaction event."
        },
        "notes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DepositTxnNotes"
            }
        },
        "depositInfo":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DepositTxnDepositInfo"
            }
        },
        "depositDetails":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DepositTxnDepositDetails"
            }
        },
        "balanceImpacts":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DepositTxnBalanceImpacts"
            }
        },
        "payment":{
            "$ref":"#/components/schemas/DepositTxnPayment"
        }
    },
    "xml":{
        "name":"depositTxn"
    }
}

Nested Schema : balanceImpacts

Type: array

Show Source

• Array of: object DepositTxnBalanceImpacts

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DepositTxnBalanceImpacts"
    }
}

Nested Schema : depositDetails

Type: array

Show Source

• Array of: object DepositTxnDepositDetails

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DepositTxnDepositDetails"
    }
}

Nested Schema : depositInfo

Type: array

Show Source

• Array of: object DepositTxnDepositInfo

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DepositTxnDepositInfo"
    }
}

Nested Schema : notes

Type: array

Show Source

• Array of: object DepositTxnNotes

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DepositTxnNotes"
    }
}

Nested Schema : DepositTxnPayment

Type: object

Show Source

• 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.
• paymentAmount: object Money
• 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)

{
    "required":[
        "completedAt",
        "createdAt",
        "customerDepositRef",
        "customerRef",
        "glCode",
        "href",
        "id",
        "notes",
        "paymentRef"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The deposit payment ID."
        },
        "href":{
            "type":"string",
            "description":"The unique resource URL, used to get the deposit payment."
        },
        "createdAt":{
            "type":"string",
            "description":"The date when the deposit payment is created."
        },
        "completedAt":{
            "type":"string",
            "description":"The date when the deposit payment is completed."
        },
        "status":{
            "type":"integer",
            "description":"The deposit payment transaction status. Allowed Values: <ul><li><b>1</b> (Completed)</li><li><b>2</b> (Failed)</li><li><b>3</b> (Pending)</li></ul>",
            "format":"int32"
        },
        "paymentAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "customerRef":{
            "type":"string",
            "description":"The customer reference."
        },
        "customerDepositRef":{
            "type":"string",
            "description":"The deposit reference."
        },
        "notes":{
            "type":"string",
            "description":"The notes for the deposit payment."
        },
        "paymentMethodType":{
            "type":"integer",
            "description":"The payment method type. Allowed Values: <ul><li><b>10003</b> (Credit card)</li><li><b>10005</b> (Direct debit)</li><li><b>10011</b> (Cash)</li><li><b>10012</b> (Check)</li><li><b>10013</b> (Wire Transfer)</li><li><b>10014</b> (Inter-bank payment order)</li><li><b>10015</b> (Postal order)</li><li><b>3</b> (Prepayment)</li><li><b>4</b> (Other)</li></ul>",
            "format":"int32"
        },
        "paymentRef":{
            "type":"string",
            "description":"The payment reference."
        },
        "glCode":{
            "type":"string",
            "description":"The general ledger code for the deposit payment."
        }
    }
}

Nested Schema : DepositTxnBalanceImpacts

Type: object

Show Source

• amount: object Money
• discountAmount: object Money
• resourceId(required): string
  The balance impact's resource ID.
• tax: object Money

{
    "required":[
        "resourceId"
    ],
    "type":"object",
    "properties":{
        "resourceId":{
            "type":"string",
            "description":"The balance impact's resource ID."
        },
        "tax":{
            "$ref":"#/components/schemas/Money"
        },
        "amount":{
            "$ref":"#/components/schemas/Money"
        },
        "discountAmount":{
            "$ref":"#/components/schemas/Money"
        }
    }
}

Nested Schema : Money

Type: object

Show Source

• amount(required): number
  The amount of money.
• currency: integer (int32)
  The currency for the money.

{
    "required":[
        "amount"
    ],
    "type":"object",
    "properties":{
        "amount":{
            "type":"number",
            "description":"The amount of money."
        },
        "currency":{
            "type":"integer",
            "description":"The currency for the money.",
            "format":"int32"
        }
    }
}

Nested Schema : DepositTxnDepositDetails

Type: object

Show Source

• depositRef(required): string
  The deposit reference.
• destDepositRef(required): string
  The destination deposit reference.
• sourceDepositRef(required): string
  The source deposit reference.

{
    "required":[
        "depositRef",
        "destDepositRef",
        "sourceDepositRef"
    ],
    "type":"object",
    "properties":{
        "depositRef":{
            "type":"string",
            "description":"The deposit reference."
        },
        "sourceDepositRef":{
            "type":"string",
            "description":"The source deposit reference."
        },
        "destDepositRef":{
            "type":"string",
            "description":"The destination deposit reference."
        }
    }
}

Nested Schema : DepositTxnDepositInfo

Type: object

Show Source

• 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.

{
    "required":[
        "billInfoRef",
        "customerRef",
        "serviceRef",
        "toBillInfoRef",
        "toServiceRef"
    ],
    "type":"object",
    "properties":{
        "customerRef":{
            "type":"string",
            "description":"The customer reference."
        },
        "dayOfWeek":{
            "type":"integer",
            "description":"The day of the week.",
            "format":"int32"
        },
        "amount":{
            "$ref":"#/components/schemas/Money"
        },
        "serviceRef":{
            "type":"string",
            "description":"The service reference."
        },
        "billInfoRef":{
            "type":"string",
            "description":"The bill reference."
        },
        "toServiceRef":{
            "type":"string",
            "description":"The service reference to which the transaction is made."
        },
        "toBillInfoRef":{
            "type":"string",
            "description":"The bill reference to which the transaction is made."
        }
    }
}

Nested Schema : DepositTxnNotes

Type: object

Show Source

• 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.

{
    "required":[
        "createdAt",
        "id",
        "modifiedAt",
        "note"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The deposit transaction note ID."
        },
        "note":{
            "type":"string",
            "description":"The deposit transaction note."
        },
        "createdAt":{
            "type":"string",
            "description":"The date when the deposit transaction note is created."
        },
        "modifiedAt":{
            "type":"string",
            "description":"The date when the deposit transaction note is modified."
        }
    }
}

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+-event-billing-item-transfer+332984897451942258'

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-item-transfer+332984897451942258",
    "href": "http://hostname:port/bcws/webresources/version/depositManagement/depositTxn/0.0.0.1+-event-billing-item-transfer+332984897451942258",
    "txnType": "Billing Change Item Event",
    "descr": "",
    "createdAt": "2021-10-28T07:10:56.000Z",
    "modifiedAt": "2021-10-28T07:10:56.000Z",
    "quantity": 0,
    "depositInfo": [{
            "amount": {
                "amount": 36
            }
        }
    ]
}

Back to Top