Jump to

• Request
• Response

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(optional): string
  From Amount
• amountTo(optional): string
  To Amount
• chequeNumber(optional): string
  Cheque Number
• corporateId: string
  Corporate Id
• debitAccountNo(optional): string
  Debit Account Number
• debitStatus(optional): string
  Debit Status Code
• deliveryPointCode(optional): string
  Delivery Point Code
• extRefNumber(optional): string
  External Reference Number
• limit(optional): integer
  Limit to be fetched
• offset(optional): integer
  Offset of the limit
• processingFromDate(optional): string
  Processing From Date
• processingToDate(optional): string
  Processing To Date
• referenceNumber(optional): string
  Reference Number
• requestFromDate(optional): string
  Request From Date
• requestToDate(optional): string
  Request To Date
• slipNumber(optional): string
  Slip Number
• withdrawalAmtCCY(optional): string
  Withdrawal Amount CCY
• withdrawalBranchCode(optional): string
  Withdrawal Branch
• withdrawalFromDate(optional): string
  Withdrawal From Date
• withdrawalToDate(optional): string
  Withdrawal To Date

Header Parameters

• appId: string
  Application ID for SMS
• authToken(optional): string
  Authentication Token
• branchCode: string
  Unique Branch Code
• contentType(optional): string
  Content of a file
• tenantId(optional): string
  Tenant ID for SMS
• userId: string
  User id for SMS

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successful performs the operation

Body ()

Root Schema : CashWithdrawalEnquiryResponseModel

Type: object

Collection of CashWithdrawal Model

Show Source

• cashWithdrawalData(optional): array cashWithdrawalData
• errors(optional): object errors
  List Of Errors
• paging(optional): object PagingDto
• responseStatus(optional): 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
  Error Model

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

Nested Schema : CashWithDrawalEnquiryModel

Type: object

Cash Withdrawal Enquiry Model

Show Source

• action(optional): string
  Action
• amount(optional): number
  Amount
• amtAccCcy(optional): number
  Amount Account Ccy
• authStat(optional): string
  Authorization Status
• branchCode(optional): string
  branchCode
• cashWithdrawalEnquiryDenominationfFieldsData(optional): array cashWithdrawalEnquiryDenominationfFieldsData
• cashWithdrawalEnquiryMiscFieldsData(optional): object CashWithdrawalEnquiryMiscFieldsModel
  Collection of Cashwithdrawal Enquiry Misc Fields Model
• channel(optional): string
  Channel
• channelWithdrawalBranch(optional): string
  Channel Withdrawal Branch
• checkerDtStamp(optional): string
  CheckerDateStamp
• checkerId(optional): string
  Checker Id
• checkerRemarks(optional): string
  Checker Remarks
• chequeDate(optional): string
  Cheque Date
• chequeNo(optional): number
  Cheque Number
• consignmentDate(optional): string
  Consignment Date
• consignmentNo(optional): string
  Consignment Number
• contactNo(optional): string
  Contact Number
• corporateId(optional): string
  Corporate Id
• corporateName(optional): string
  Corporate Name
• corporateRefNo(optional): string
  Corporate Reference Number
• courierCode(optional): string
  Courier Code
• currency(optional): string
  Currency
• debitAccountNo(optional): string
  Debit Account Number
• debitACCY(optional): string
  Debit Account CCY
• debitDate(optional): string
  Debit Date
• debitStatus(optional): string
  Debit Status
• deliveryPointCode(optional): string
  Delivery Point Code
• deliveryPointDesc(optional): string
  Delivery Point Description
• denominationCount(optional): number
  Denomination Count
• exchangeRate(optional): number
  Exchange Rate
• externalChannel(optional): string
  External Channel
• extReferenceNo(optional): string
  External Reference Number
• id(optional): string
  Id of the cashwithdrawal
• idProofDetail(optional): string
  Id Proof Detail
• idProofType(optional): string
  Id Proof Type
• lienAmount(optional): number
  Lien Amount
• lienDate(optional): string
  Lien Date
• lienNumber(optional): string
  Lien Number
• makerDtStamp(optional): string
  MakerDateStamp
• makerId(optional): string
  Maker Id
• makerRemarks(optional): string
  Maker Remarks
• modNo(optional): integer
  Mod No of the cashwithdrawal
• onceAuth(optional): string
  Once Authorization
• processingDate(optional): string
  Processing Date
• processingStatus(optional): string
  Stage
• recipientName(optional): string
  recipient Name
• recipientType(optional): string
  Recipient Type
• recordStat(optional): string
  Record Status
• requestedDate(optional): string
  Requested Date
• slipNo(optional): number
  Slip Number
• stage(optional): string
  Stage
• transactionRefNo(optional): string
  Transaction Reference Number
• vaFlagYN(optional): string
  Virtual Account Falg(Y/N)
• withdrawalDate(optional): string
  Channel Withdrawal Date
• withdrawalSlipDate(optional): 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(optional): string
  1st Miscellaneous Field
• misc10(optional): string
  10th Miscellaneous Field
• misc11(optional): string
  11th Miscellaneous Field
• misc12(optional): string
  12th Miscellaneous Field
• misc13(optional): string
  13th Miscellaneous Field
• misc14(optional): string
  14th Miscellaneous Field
• misc15(optional): string
  15th Miscellaneous Field
• misc16(optional): string
  16th Miscellaneous Field
• misc17(optional): string
  17th Miscellaneous Field
• misc18(optional): string
  18th Miscellaneous Field
• misc19(optional): string
  19th Miscellaneous Field
• misc2(optional): string
  2nd Miscellaneous Field
• misc20(optional): string
  20th Miscellaneous Field
• misc21(optional): string
  21st Miscellaneous Field
• misc22(optional): string
  22nd Miscellaneous Field
• misc23(optional): string
  23rd Miscellaneous Field
• misc24(optional): string
  24th Miscellaneous Field
• misc25(optional): string
  25th Miscellaneous Field
• misc26(optional): string
  26th Miscellaneous Field
• misc27(optional): string
  27th Miscellaneous Field
• misc28(optional): string
  28th Miscellaneous Field
• misc29(optional): string
  29th Miscellaneous Field
• misc3(optional): string
  3rd Miscellaneous Field
• misc30(optional): string
  30th Miscellaneous Field
• misc4(optional): string
  4th Miscellaneous Field
• misc5(optional): string
  5th Miscellaneous Field
• misc6(optional): string
  6th Miscellaneous Field
• misc7(optional): string
  7th Miscellaneous Field
• misc8(optional): string
  8th Miscellaneous Field
• misc9(optional): string
  9th Miscellaneous Field
• noOfMiscFields(optional): 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(optional): string
  CheckerDateStamp
• checkerId(optional): string
  Checker Id
• denominationAmount(optional): number
  Denomination Amount
• denominationCount(optional): number
  Denomination Count
• denominationRefNo(optional): string
  Denomination Reference Number
• denominationType(optional): string
  Denomination Type
• denominationValue(optional): number
  Denomination Value
• depositSlipNo(optional): number
  DepositSlip Number
• depositSlipRefNo(optional): string
  DepositSlip Reference Number
• id(optional): string
  Id for Denomination
• makerDtStamp(optional): string
  MakerDateStamp
• makerId(optional): string
  Maker Id
• referenceNum(optional): string
  Reference Number
• seqNo(optional): 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

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

Back to Top