Rest API for Oracle Banking Cash Management

Fetch the list of cash withdrawals

get

/service/v1/cashWithdrawalInquiry

This endpoint fetches the list of cash withdrawals based on given parameters.

Request

Supported Media Types

application/json
application/xml

Query Parameters

amountFrom: string

From Amount
amountTo: string

To Amount
chequeNumber: string

Cheque Number
corporateId(required): string

Corporate Id
debitAccountNo: string

Debit Account Number
debitStatus: string

Debit Status Code
deliveryPointCode: string

Delivery Point Code
extRefNumber: string

External Reference Number
limit: integer

Limit to be fetched
offset: integer

Offset of the limit
processingFromDate: string

Processing From Date
processingToDate: string

Processing To Date
referenceNumber: string

Reference Number
requestFromDate: string

Request From Date
requestToDate: string

Request To Date
slipNumber: string

Slip Number
withdrawalAmtCCY: string

Withdrawal Amount CCY
withdrawalBranchCode: string

Withdrawal Branch
withdrawalFromDate: string

Withdrawal From Date
withdrawalToDate: string

Withdrawal To Date

Header Parameters

appId(required): string

Application ID for SMS
authToken: string

Authentication Token
branchCode(required): string

Unique Branch Code
contentType: string

Content of a file
tenantId: string

Tenant ID for SMS
userId(required): string

User id for SMS

Response

Supported Media Types

application/json
application/xml

200 Response

Successful performs the operation

Root Schema : CashWithdrawalEnquiryResponseModel

Type: object

Collection of CashWithdrawal Model

Show Source

cashWithdrawalData: array cashWithdrawalData
errors: object errors

List Of Errors
paging: object PagingDto
responseStatus: string

Response Status

{
    "description":"Collection of CashWithdrawal Model",
    "type":"object",
    "properties":{
        "responseStatus":{
            "type":"string",
            "description":"Response Status"
        },
        "cashWithdrawalData":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CashWithDrawalEnquiryModel"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        },
        "errors":{
            "type":"object",
            "description":"List Of Errors ",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : cashWithdrawalData

Type: array

Show Source

Array of: object CashWithDrawalEnquiryModel

Cash Withdrawal Enquiry Model

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CashWithDrawalEnquiryModel"
    }
}

Nested Schema : errors

Type: object

List Of Errors

Show Source

Array of: object Error

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

Nested Schema : PagingDto

Type: object

Show Source

totalResults: integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : CashWithDrawalEnquiryModel

Type: object

Cash Withdrawal Enquiry Model

Show Source

action: string

Action
amount: number

Amount
amtAccCcy: number

Amount Account Ccy
authStat: string

Authorization Status
branchCode: string

branchCode
cashWithdrawalEnquiryDenominationfFieldsData: array cashWithdrawalEnquiryDenominationfFieldsData
cashWithdrawalEnquiryMiscFieldsData: object CashWithdrawalEnquiryMiscFieldsModel

Collection of Cashwithdrawal Enquiry Misc Fields Model
channel: string

Channel
channelWithdrawalBranch: string

Channel Withdrawal Branch
checkerDtStamp: string

CheckerDateStamp
checkerId: string

Checker Id
checkerRemarks: string

Checker Remarks
chequeDate: string

Cheque Date
chequeNo: number

Cheque Number
consignmentDate: string

Consignment Date
consignmentNo: string

Consignment Number
contactNo: string

Contact Number
corporateId: string

Corporate Id
corporateName: string

Corporate Name
corporateRefNo: string

Corporate Reference Number
courierCode: string

Courier Code
currency: string

Currency
debitAccountNo: string

Debit Account Number
debitACCY: string

Debit Account CCY
debitDate: string

Debit Date
debitStatus: string

Debit Status
deliveryPointCode: string

Delivery Point Code
deliveryPointDesc: string

Delivery Point Description
denominationCount: number

Denomination Count
exchangeRate: number

Exchange Rate
externalChannel: string

External Channel
extReferenceNo: string

External Reference Number
id: string

Id of the cashwithdrawal
idProofDetail: string

Id Proof Detail
idProofType: string

Id Proof Type
lienAmount: number

Lien Amount
lienDate: string

Lien Date
lienNumber: string

Lien Number
makerDtStamp: string

MakerDateStamp
makerId: string

Maker Id
makerRemarks: string

Maker Remarks
modNo: integer

Mod No of the cashwithdrawal
onceAuth: string

Once Authorization
processingDate: string

Processing Date
processingStatus: string

Stage
recipientName: string

recipient Name
recipientType: string

Recipient Type
recordStat: string

Record Status
requestedDate: string

Requested Date
slipNo: number

Slip Number
stage: string

Stage
transactionRefNo: string

Transaction Reference Number
vaFlagYN: string

Virtual Account Falg(Y/N)
withdrawalDate: string

Channel Withdrawal Date
withdrawalSlipDate: string

WithdrawalSlipDate

{
    "description":"Cash Withdrawal Enquiry Model",
    "type":"object",
    "properties":{
        "id":{
            "description":"Id of the cashwithdrawal",
            "type":"string"
        },
        "modNo":{
            "description":"Mod No of the cashwithdrawal",
            "type":"integer"
        },
        "action":{
            "description":"Action",
            "type":"string"
        },
        "amount":{
            "description":"Amount",
            "type":"number"
        },
        "authStat":{
            "description":"Authorization Status",
            "type":"string"
        },
        "branchCode":{
            "description":"branchCode",
            "type":"string"
        },
        "checkerDtStamp":{
            "description":"CheckerDateStamp",
            "type":"string"
        },
        "checkerId":{
            "description":"Checker Id",
            "type":"string"
        },
        "checkerRemarks":{
            "description":"Checker Remarks",
            "type":"string"
        },
        "chequeDate":{
            "description":"Cheque Date",
            "type":"string"
        },
        "chequeNo":{
            "description":"Cheque Number",
            "type":"number"
        },
        "consignmentDate":{
            "description":"Consignment Date",
            "type":"string"
        },
        "consignmentNo":{
            "description":"Consignment Number",
            "type":"string"
        },
        "contactNo":{
            "description":"Contact Number",
            "type":"string"
        },
        "corporateId":{
            "description":"Corporate Id",
            "type":"string"
        },
        "corporateName":{
            "description":"Corporate Name",
            "type":"string"
        },
        "corporateRefNo":{
            "description":"Corporate Reference Number",
            "type":"string"
        },
        "courierCode":{
            "description":"Courier Code",
            "type":"string"
        },
        "debitAccountNo":{
            "description":"Debit Account Number",
            "type":"string"
        },
        "denominationCount":{
            "description":"Denomination Count",
            "type":"number"
        },
        "extReferenceNo":{
            "description":"External Reference Number",
            "type":"string"
        },
        "idProofDetail":{
            "description":"Id Proof Detail",
            "type":"string"
        },
        "idProofType":{
            "description":"Id Proof Type",
            "type":"string"
        },
        "makerDtStamp":{
            "description":"MakerDateStamp",
            "type":"string"
        },
        "makerId":{
            "description":"Maker Id",
            "type":"string"
        },
        "makerRemarks":{
            "description":"Maker Remarks",
            "type":"string"
        },
        "onceAuth":{
            "description":"Once Authorization",
            "type":"string"
        },
        "recipientName":{
            "description":"recipient Name",
            "type":"string"
        },
        "recordStat":{
            "description":"Record Status",
            "type":"string"
        },
        "slipNo":{
            "description":"Slip Number",
            "type":"number"
        },
        "transactionRefNo":{
            "description":"Transaction Reference Number",
            "type":"string"
        },
        "currency":{
            "description":"Currency",
            "type":"string"
        },
        "exchangeRate":{
            "description":"Exchange Rate",
            "type":"number"
        },
        "amtAccCcy":{
            "description":"Amount Account Ccy",
            "type":"number"
        },
        "deliveryPointCode":{
            "description":"Delivery Point Code",
            "type":"string"
        },
        "deliveryPointDesc":{
            "description":"Delivery Point Description",
            "type":"string"
        },
        "recipientType":{
            "description":"Recipient Type",
            "type":"string"
        },
        "processingStatus":{
            "description":"Stage",
            "type":"string"
        },
        "debitStatus":{
            "description":"Debit Status",
            "type":"string"
        },
        "externalChannel":{
            "description":"External Channel",
            "type":"string"
        },
        "lienNumber":{
            "description":"Lien Number",
            "type":"string"
        },
        "lienAmount":{
            "description":"Lien Amount",
            "type":"number"
        },
        "processingDate":{
            "description":"Processing Date",
            "type":"string"
        },
        "requestedDate":{
            "description":"Requested Date",
            "type":"string"
        },
        "lienDate":{
            "description":"Lien Date",
            "type":"string"
        },
        "debitDate":{
            "description":"Debit Date",
            "type":"string"
        },
        "withdrawalSlipDate":{
            "description":"WithdrawalSlipDate",
            "type":"string"
        },
        "stage":{
            "description":"Stage",
            "type":"string"
        },
        "debitACCY":{
            "description":"Debit Account CCY",
            "type":"string"
        },
        "vaFlagYN":{
            "description":"Virtual Account Falg(Y/N)",
            "type":"string"
        },
        "channel":{
            "description":"Channel",
            "type":"string"
        },
        "channelWithdrawalBranch":{
            "description":"Channel Withdrawal Branch",
            "type":"string"
        },
        "withdrawalDate":{
            "description":"Channel Withdrawal Date",
            "type":"string"
        },
        "cashWithdrawalEnquiryMiscFieldsData":{
            "$ref":"#/definitions/CashWithdrawalEnquiryMiscFieldsModel"
        },
        "cashWithdrawalEnquiryDenominationfFieldsData":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CashWithdrawalEnquiryDenominationFieldsModel"
            }
        }
    }
}

Nested Schema : cashWithdrawalEnquiryDenominationfFieldsData

Type: array

Show Source

Array of: object CashWithdrawalEnquiryDenominationFieldsModel

Collection of CashWithdrawal Enquiry Denomination Fields Model

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CashWithdrawalEnquiryDenominationFieldsModel"
    }
}

Nested Schema : CashWithdrawalEnquiryMiscFieldsModel

Type: object

Collection of Cashwithdrawal Enquiry Misc Fields Model

Show Source

misc1: string

1st Miscellaneous Field
misc10: string

10th Miscellaneous Field
misc11: string

11th Miscellaneous Field
misc12: string

12th Miscellaneous Field
misc13: string

13th Miscellaneous Field
misc14: string

14th Miscellaneous Field
misc15: string

15th Miscellaneous Field
misc16: string

16th Miscellaneous Field
misc17: string

17th Miscellaneous Field
misc18: string

18th Miscellaneous Field
misc19: string

19th Miscellaneous Field
misc2: string

2nd Miscellaneous Field
misc20: string

20th Miscellaneous Field
misc21: string

21st Miscellaneous Field
misc22: string

22nd Miscellaneous Field
misc23: string

23rd Miscellaneous Field
misc24: string

24th Miscellaneous Field
misc25: string

25th Miscellaneous Field
misc26: string

26th Miscellaneous Field
misc27: string

27th Miscellaneous Field
misc28: string

28th Miscellaneous Field
misc29: string

29th Miscellaneous Field
misc3: string

3rd Miscellaneous Field
misc30: string

30th Miscellaneous Field
misc4: string

4th Miscellaneous Field
misc5: string

5th Miscellaneous Field
misc6: string

6th Miscellaneous Field
misc7: string

7th Miscellaneous Field
misc8: string

8th Miscellaneous Field
misc9: string

9th Miscellaneous Field
noOfMiscFields: number

noOfMiscFields

{
    "description":"Collection of Cashwithdrawal Enquiry Misc Fields Model",
    "type":"object",
    "properties":{
        "noOfMiscFields":{
            "description":"noOfMiscFields",
            "type":"number"
        },
        "misc1":{
            "description":"1st Miscellaneous Field",
            "type":"string"
        },
        "misc2":{
            "description":"2nd Miscellaneous Field",
            "type":"string"
        },
        "misc3":{
            "description":"3rd Miscellaneous Field",
            "type":"string"
        },
        "misc4":{
            "description":"4th Miscellaneous Field",
            "type":"string"
        },
        "misc5":{
            "description":"5th Miscellaneous Field",
            "type":"string"
        },
        "misc6":{
            "description":"6th Miscellaneous Field",
            "type":"string"
        },
        "misc7":{
            "description":"7th Miscellaneous Field",
            "type":"string"
        },
        "misc8":{
            "description":"8th Miscellaneous Field",
            "type":"string"
        },
        "misc9":{
            "description":"9th Miscellaneous Field",
            "type":"string"
        },
        "misc10":{
            "description":"10th Miscellaneous Field",
            "type":"string"
        },
        "misc11":{
            "description":"11th Miscellaneous Field",
            "type":"string"
        },
        "misc12":{
            "description":"12th Miscellaneous Field",
            "type":"string"
        },
        "misc13":{
            "description":"13th Miscellaneous Field",
            "type":"string"
        },
        "misc14":{
            "description":"14th Miscellaneous Field",
            "type":"string"
        },
        "misc15":{
            "description":"15th Miscellaneous Field",
            "type":"string"
        },
        "misc16":{
            "description":"16th Miscellaneous Field",
            "type":"string"
        },
        "misc17":{
            "description":"17th Miscellaneous Field",
            "type":"string"
        },
        "misc18":{
            "description":"18th Miscellaneous Field",
            "type":"string"
        },
        "misc19":{
            "description":"19th Miscellaneous Field",
            "type":"string"
        },
        "misc20":{
            "description":"20th Miscellaneous Field",
            "type":"string"
        },
        "misc21":{
            "description":"21st Miscellaneous Field",
            "type":"string"
        },
        "misc22":{
            "description":"22nd Miscellaneous Field",
            "type":"string"
        },
        "misc23":{
            "description":"23rd Miscellaneous Field",
            "type":"string"
        },
        "misc24":{
            "description":"24th Miscellaneous Field",
            "type":"string"
        },
        "misc25":{
            "description":"25th Miscellaneous Field",
            "type":"string"
        },
        "misc26":{
            "description":"26th Miscellaneous Field",
            "type":"string"
        },
        "misc27":{
            "description":"27th Miscellaneous Field",
            "type":"string"
        },
        "misc28":{
            "description":"28th Miscellaneous Field",
            "type":"string"
        },
        "misc29":{
            "description":"29th Miscellaneous Field",
            "type":"string"
        },
        "misc30":{
            "description":"30th Miscellaneous Field",
            "type":"string"
        }
    }
}

Nested Schema : CashWithdrawalEnquiryDenominationFieldsModel

Type: object

Collection of CashWithdrawal Enquiry Denomination Fields Model

Show Source

checkerDtStamp: string

CheckerDateStamp
checkerId: string

Checker Id
denominationAmount: number

Denomination Amount
denominationCount: number

Denomination Count
denominationRefNo: string

Denomination Reference Number
denominationType: string

Denomination Type
denominationValue: number

Denomination Value
depositSlipNo: number

DepositSlip Number
depositSlipRefNo: string

DepositSlip Reference Number
id: string

Id for Denomination
makerDtStamp: string

MakerDateStamp
makerId: string

Maker Id
referenceNum: string

Reference Number
seqNo: number

Seq No

{
    "description":"Collection of CashWithdrawal Enquiry Denomination Fields Model",
    "type":"object",
    "properties":{
        "id":{
            "description":"Id for Denomination",
            "type":"string"
        },
        "denominationAmount":{
            "description":"Denomination Amount",
            "type":"number"
        },
        "denominationCount":{
            "description":"Denomination Count",
            "type":"number"
        },
        "denominationRefNo":{
            "description":"Denomination Reference Number",
            "type":"string"
        },
        "denominationType":{
            "description":"Denomination Type",
            "type":"string"
        },
        "denominationValue":{
            "description":"Denomination Value",
            "type":"number"
        },
        "depositSlipNo":{
            "description":"DepositSlip Number",
            "type":"number"
        },
        "depositSlipRefNo":{
            "description":"DepositSlip Reference Number",
            "type":"string"
        },
        "referenceNum":{
            "description":"Reference Number",
            "type":"string"
        },
        "seqNo":{
            "description":"Seq No",
            "type":"number"
        },
        "makerId":{
            "description":"Maker Id",
            "type":"string"
        },
        "makerDtStamp":{
            "description":"MakerDateStamp",
            "type":"string"
        },
        "checkerId":{
            "description":"Checker Id",
            "type":"string"
        },
        "checkerDtStamp":{
            "description":"CheckerDateStamp",
            "type":"string"
        }
    }
}

Nested Schema : Error

Type: object

Show Source

ecode: string
edesc: string
etype: string

{
    "type":"object",
    "properties":{
        "ecode":{
            "type":"string"
        },
        "etype":{
            "type":"string"
        },
        "edesc":{
            "type":"string"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error