Rest API for Oracle Banking Cash Management

Fetch the cash deposit slip data

get

/service/v1/cashDepositInquiry

This endpoint fetches cash deposit slip data based on given parameters.

Request

Supported Media Types

application/json
application/xml

Query Parameters

accountNumber(optional): string

Reference of the Account Number
amountFrom(optional): number

Reference of the From Amount
amountTo(optional): number

Reference of the To Amount
amtRefBasis(optional): string

Reference of the Amount
corporate(optional): string

Reference of the Corporate
courier(optional): string

Courier information

creditStatus(optional): array

Reference of the Credit Status

[0]: string

{
    "name":"creditStatus",
    "in":"query",
    "description":"Reference of the Credit Status",
    "required":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

currency(optional): string

Currency
dateFrom(optional): string

Reference of the From Date
dateRefBasis(optional): string

Reference Date
dateTo(optional): string

Reference of the To Date
depositBranch(optional): string

Reference of the Deposit Branch
depositChannel(optional): string

Reference of the Deposit Channel
depositLocation(optional): string

Reference of the Deposit Location
depositSlipNo(optional): string

Deposit Slip No
depositSlipRefNo(optional): string

Reference Number of the Deposit Slip
divisionCode(optional): string

Reference of the Division Code
extRefNumber(optional): string

Reference of the External Reference Number
limit(optional): integer

Limit to be fetched
offset(optional): integer

Offset of the limit
pickupFromDate(optional): string

Pick Up From Date
pickupLocationCode(optional): string

Pick Up Location Code
pickupPointCode(optional): string

Pick Up Point Code
pickupToDate(optional): string

Pick Up To Date

processingStatus(optional): array

Reference of the Processing Status

[0]: string

{
    "name":"processingStatus",
    "in":"query",
    "description":"Reference of the Processing Status",
    "required":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

referenceNum(optional): string

Reference Number

Header Parameters

appId: string

Application ID for SMS
authToken(optional): string

Authentication Token
branchCode: string

Unique Branch Code
branchDate(optional): string(date-time)

Branch Date
contentType(optional): string

Content of a file
tenantId(optional): string

Tenant ID for SMS
userId: string

User ID for SMS

Response

Supported Media Types

application/json
application/xml

200 Response

Successfully performs the operation and returns the Cash Slip model based on the given parameters.

Root Schema : CashSlipInstrColl

Type: object

Collection of Cash Deposit Inquiry

Show Source

cashSlipInstrumentList(optional): array cashSlipInstrumentList

Cash Deposit Summary Model
errors(optional): object errors

List Of Errors
paging(optional): object PagingDto

Paging Dto
status(optional): string

Status

{
    "description":"Collection of Cash Deposit Inquiry",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status"
        },
        "errors":{
            "type":"object",
            "description":"List Of Errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        },
        "cashSlipInstrumentList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CashDepositSummaryModel"
            },
            "description":"Cash Deposit Summary Model"
        },
        "paging":{
            "$ref":"#/definitions/PagingDto",
            "description":"Paging Data Object"
        }
    }
}

Nested Schema : cashSlipInstrumentList

Type: array

Cash Deposit Summary Model

Show Source

Array of: object CashDepositSummaryModel

Collection of Cash Deposit and Batch

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CashDepositSummaryModel"
    },
    "description":"Cash Deposit Summary Model"
}

Nested Schema : errors

Type: object

List Of Errors

Show Source

Array of: object Error

Error Model

{
    "type":"object",
    "description":"List Of Errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Nested Schema : PagingDto

Type: object

Paging Dto

Show Source

totalResults(optional): integer

Total Results

{
    "type":"object",
    "description":"Paging Dto",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"Total Results"
        }
    }
}

Nested Schema : CashDepositSummaryModel

Type: object

Collection of Cash Deposit and Batch

Show Source

BatchModel(optional): object BatchModel

Batch Data Model
CashSlipModel(optional): object CashSlipModel

CashSlip Data Model

{
    "description":"Collection of Cash Deposit and Batch",
    "type":"object",
    "properties":{
        "CashSlipModel":{
            "$ref":"#/definitions/CashSlipModel",
            "description":"Cash Slip Model"
        },
        "BatchModel":{
            "$ref":"#/definitions/BatchModel",
            "description":"Batch Model"
        }
    }
}

Nested Schema : BatchModel

Type: object

Batch Data Model

Nested Schema : CashSlipModel

Type: object

CashSlip Data Model

Nested Schema : Error

Type: object

Error Model

Show Source

errorCode(optional): string

Error Code
errorDescription(optional): string

Error Description
errorStatus(optional): string

Error Status

{
    "type":"object",
    "description":"Error Model",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Code"
        },
        "errorDescription":{
            "type":"string",
            "description":"Error Description"
        },
        "errorStatus":{
            "type":"string",
            "description":"Error Status"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error