Fetch the Instrument collection data
get
/service/v1/instrumentEnquiry
This endpoint fetches the instrument collection data based on given parameters.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
accountNumber: string
Account Number
-
clearingLocation: string
Clearing Location
-
corporateId: string
Corporate Id
-
corrBankCode: string
Current Bank Code
-
courierCode: string
Courier Code
-
creditStatus: string
credit Status
-
dateRefBasis: string
Reference Date Basis
-
depositBranch: string
Deposit Branch
-
depositChannel: string
Deposit Channel
-
depositFromDate: string
Deposit From Date
-
depositLocation: string
Deposit Branch Location
-
depositSlipNumber: string
Deposit Slip Number
-
depositToDate: string
Deposit ToDate
-
divisionCode: string
Division Code
-
drawerAcNo: string
Drawer Account No
-
drawnOnBankCode: string
Drawn BankCode
-
extRefNo: string
External Reference No
-
fromDate: string
From-Date
-
instAmtCcy: string
Instrument Amount Currency
-
instFromDate: string
Instrument From Date
-
instMgmtCourierCode: string
Instrument Management Courier Code
-
instToDate: string
Instrument To Date
-
instTxnStatus: string
Instrument Transaction Status
-
instrumentAmountFrom: number
Instrument Amount From
-
instrumentAmountTo: number
Instrument Amount To
-
instrumentAmt: number
Instrument Amount
-
instrumentNumber: string
Instrument Number
-
instrumentStatus: string
Instrument Status
-
isPDCChecked: string
isPDCChecked flag value
-
locationCode: string
Location Code
-
pickupCode: string
Pickup Code
-
pickupFromDate: string
Pick Up From Date
-
pickupToDate: string
Pick Up To Date
-
processingStatus: string
Processing Status
-
product: string
Product Code
-
referenceNum: string
Reference Number
-
routingNumber: number
Routing Number
-
scheduleDestinationBank: string
Destination Bank
-
scheduleDestinationBranch: string
Destination branch
-
scheduleDispatchDateFrom: string
Scheduled Dispatch Date From
-
scheduleDispatchDateTo: string
Scheduled Dispatch Date To
-
scheduleOriginationBranch: string
Origin branch
-
scheduleRefNo: string
Schedule Reference no
-
toDate: string
To-Date
-
txnRefNo: string
Instrument Reference no
-
vaultBoxNumber: string
Vault BoxNumber
Header Parameters
-
appId(required): string
Application ID for SMS
-
authToken: string
Authentication Token
-
branchCode(required): string
Branch Code
-
contentType: string
Content of a file
-
tenantId: string
Tenant ID
-
userId(required): string
User ID for SMS
Response
Supported Media Types
- application/json
- application/xml
200 Response
Successful performs the operation
Nested Schema : InstrumentList
Type:
Show Source
array-
Array of:
object InstrumentEnquiryModel
DataSlips additional Field
Nested Schema : InstrumentEnquiryModel
Type:
objectDataSlips additional Field
Show Source
-
accountType:
string
Account Type
-
acknowledgementReciptNo:
string
Acknowledgement ReciptNo
-
actualCreditDate:
string(Date)
Actual Credit Date
-
actualCreditReversalDate:
string
Actual Credit Reversal Date
-
adhocCharges:
number
Adhoc Charges
-
arrangementCode:
string
Arrangement Code
-
arrangementCreditDate:
string
arrangementCreditDate
-
arrangementCreditReversalDate:
string
Arrangement Credit Reversal Date
-
arrangementDays:
integer
Arrangement Days
-
arrangementDesc:
string
Arrangement Description
-
arrangementRefBasis:
string
Arrangement Ref Basis
-
bagWeight:
number
BagWeight
-
branchCode:
string
Branch Code
-
centralizedSchdGenerationDate:
string
Centralized Schedule Generation Date
-
centralizedScheduleRefNo:
string
Centralized Schedule RefNo
-
certificateExtensionDays:
integer
Certificate Extension Days
-
checkerDtStamp:
string
Checker Date-Stamp
-
checkerId:
string
Checker Id
-
clearingNetworkCode:
string
Clearing Network Code
-
clearingNetworkDesc:
string
Clearing Network Desc
-
consignmentDate:
string
Consignment Date
-
consignmentNo:
string
Consignment No
-
coreBankBranchCode:
string
Core Bank Branch Code
-
corporateId:
string
Corporate Id
-
corporateName:
string
Corporate Name
-
corporateRefNo:
string
Corporate Reference No
-
corporateReleaseDays:
integer
Corporate Release Days
-
corrBankCode:
string
Corresponding BankCode
-
courierCode:
string
Courier Code
-
courierDesc:
string
Courier Description
-
creditAccountNo:
string
Credit Account No
-
creditStatus:
string
credit status of the Instrument
-
depCreditAccountNo:
string
Deposit Slip Credit Account No
-
depositChannel:
string
Deposit Channel
-
depositeSlipMiscFields:
object DepositeSlipMiscFieldsModel
DepositeSlipMiscFieldsModel
-
depositeSlipUdfFields:
array depositeSlipUdfFields
-
depositLocationCode:
string
Deposit Location Code
-
depositLocationDesc:
string
Deposit Location Description
-
depositSlipAmount:
number
Deposit Slip Amount
-
depositSlipDate:
string
Deposit Slip Date
-
depositSlipNo:
string
no of the DepositSlipNo
-
depositSlipRefNo:
string
deposit Slip Ref No of the Instrument
-
depSlipDivisionCode:
string
Division Code in Deposit Slip
-
depSlipDivisionCodeDesc:
string
Division Code Description in Deposit Slip
-
divisionCode:
string
Division Code
-
divisionCodeDesc:
string
Division Code Description
-
drawerAcName:
string
Drawer Account Name
-
drawerAcNo:
string
Drawer Account No
-
drawerId:
string
Drawer Id
-
drawerName:
string
Drawer Name
-
drawnOnBankCode:
string
Drawn Bank Code
-
drawnOnBankName:
string
Drawn Bank Name
-
drawnOnBranchCode:
string
Drawn Branch Code
-
drawnOnBranchName:
string
Drawn Branch Name
-
eventCode:
string
Event Code for accounting
-
expectedClearingDate:
string
Expected Clearing Date
-
expectedCreditDate:
string(Date)
Expected Credit Date
-
expectedCreditReversalDate:
string
Expected Credit Reversal Date
-
extRefNo:
string
External Reference No
-
financialPosting:
string
Financial Posting
-
fromDate:
string
From Date
-
holdUntillDate:
string
Hold Untill Date
-
id:
string
Id of the Instrument
-
initatorRefNo:
string
Initator Ref No
-
instMgmtCourierCode:
string
instMgmtCourierCode
-
instMgmtCourierPodNumber:
string
instMgmtCourierPodNumber
-
instrumentAmountValue:
number
Instrument Amount Value
-
instrumentAmt:
number
Instrument Amount
-
instrumentAmtCcy:
string
Instrument Amount Currency
-
instrumentCount:
number
Instrument Count
-
instrumentDate:
string
Instrument Date
-
instrumentManagementBatchRefNo:
string
Instrument Management Batch Ref No
-
instrumentMiscFields:
object InstrumentMiscFieldsModel
InstrumentMiscFieldsModel
-
instrumentNo:
string
no of the Instrument
-
instrumentRefNo:
string
Instrument Ref No of the Instrument
-
instrumentStatus:
string
Instrument Status
-
instrumentType:
string
Instrument Type
-
instrumentUdfFields:
array instrumentUdfFields
-
instTxnStatus:
string
Instrument Transaction Status
-
isCentralizedSchedule:
string
isCentralizedSchedule flag value
-
isCustomerCredited:
string
isCustomerCredited
-
isPDCChecked:
string
isPDCChecked flag value
-
lostExtensionDays:
integer
Lost Extension Days
-
makerDtStamp:
string
Maker Date-Stamp
-
makerId:
string
Maker Id
-
newCreditDate:
string
New Credit Date
-
newInstrumentNo:
string
New no of the Instrument
-
newPresentationDate:
string
New Presentation Date
-
noOfMiscFields:
integer
No Of Miscellaneous Fields
-
oldCreditDate:
string
Old Credit Date
-
oldPresentationDate:
string
Old Presentation Date
-
payableAtLocationCode:
string
Payable At Location Code
-
payableAtLocationDesc:
string
Payable At Location Description
-
payableAtLocClusterCode:
string
Payable At Location Cluster Code
-
payableAtLocClusterDesc:
string
Payable At Location Cluster Description
-
pickupDate:
string
PickUp Date
-
pickupLocationCode:
string
Pickup Location Code
-
pickUpLocationDesc:
string
PickUp Location Description
-
pickupPointCode:
string
Pickup Point Code
-
pickupPointDesc:
string
Pickup Point Description
-
presentationDate:
string
Presentation Date
-
processingDate:
string(Date)
Processing Date
-
processingStatus:
string
Processing Status
-
productCode:
string
Product Code
-
productDesc:
string
Product Description
-
realisationAmount:
number
Realisation Amount
-
realisationDate:
string
Realisation Date
-
referenceNum:
string
Reference Num of the batch
-
rejectReason:
string
Reject Reason
-
remarks:
string
Remarks
-
returnExtensionDays:
integer
Return Extension Days
-
returningDate:
string
Returning Date
-
returnRecoveryDate:
string
Return Recovery Date
-
routingNumber:
number
Routing Number
-
scheduleDestinationBank:
string
Scheduled Destination Bank
-
scheduleDestinationBankDescription:
string
Scheduled Destination Bank Description
-
scheduleDestinationBranch:
string
Scheduled Destination Branch
-
scheduleDestinationBranchDescription:
string
Schedule Destination Branch Description
-
scheduleGenerationDate:
string
Schedule Generation Date
-
scheduleOriginationBank:
string
Schedule Origination Bank
-
scheduleOriginationBranch:
string
Origin Branch
-
scheduleReceiptDate:
string
Scheduled Receipt Date
-
scheduleRefNo:
string
Schedule Reference no
-
seqNo:
integer(int64)
Seq No of the Instrument
-
stage:
string
stage
-
toDate:
string
To Date
-
totalBatchAmount:
number
Total Batch Amount
-
totalDepositSlips:
number
Total No of Deposit Slips
-
vaultBoxDescription:
string
Vault Box Description
-
vaultBoxNumber:
string
Vault Box Number
-
vaultBranch:
string
Vault Box Branch
Nested Schema : DepositeSlipMiscFieldsModel
Type:
objectDepositeSlipMiscFieldsModel
Show Source
-
misc1:
string
Miscellaneous 1
-
misc10:
string
Miscellaneous 10
-
misc11:
string
Miscellaneous 11
-
misc12:
string
Miscellaneous 12
-
misc13:
string
Miscellaneous 13
-
misc14:
string
Miscellaneous 14
-
misc15:
string
Miscellaneous 15
-
misc16:
string
Miscellaneous 16
-
misc17:
string
Miscellaneous 17
-
misc18:
string
Miscellaneous 18
-
misc19:
string
Miscellaneous 19
-
misc2:
string
Miscellaneous 2
-
misc20:
string
Miscellaneous 20
-
misc21:
string
Miscellaneous 21
-
misc22:
string
Miscellaneous 22
-
misc23:
string
Miscellaneous 23
-
misc24:
string
Miscellaneous 24
-
misc25:
string
Miscellaneous 25
-
misc26:
string
Miscellaneous 26
-
misc27:
string
Miscellaneous 27
-
misc28:
string
Miscellaneous 28
-
misc29:
string
Miscellaneous 29
-
misc3:
string
Miscellaneous 3
-
misc30:
string
Miscellaneous 30
-
misc4:
string
Miscellaneous 4
-
misc5:
string
Miscellaneous 5
-
misc6:
string
Miscellaneous 6
-
misc7:
string
Miscellaneous 7
-
misc8:
string
Miscellaneous 8
-
misc9:
string
Miscellaneous 9
-
noOfMiscFields:
integer
No of Miscellaneous Fields
Nested Schema : depositeSlipUdfFields
Type:
Show Source
array-
Array of:
object DepositeSlipUdfFieldsModel
DepositeSlipUdfFieldsModel
Nested Schema : InstrumentMiscFieldsModel
Type:
objectInstrumentMiscFieldsModel
Show Source
-
misc1:
string
Miscellaneous 1
-
misc10:
string
Miscellaneous 10
-
misc11:
string
Miscellaneous 11
-
misc12:
string
Miscellaneous 12
-
misc13:
string
Miscellaneous 13
-
misc14:
string
Miscellaneous 14
-
misc15:
string
Miscellaneous 15
-
misc16:
string
Miscellaneous 16
-
misc17:
string
Miscellaneous 17
-
misc18:
string
Miscellaneous 18
-
misc19:
string
Miscellaneous 19
-
misc2:
string
Miscellaneous 2
-
misc20:
string
Miscellaneous 20
-
misc21:
string
Miscellaneous 21
-
misc22:
string
Miscellaneous 22
-
misc23:
string
Miscellaneous 23
-
misc24:
string
Miscellaneous 24
-
misc25:
string
Miscellaneous 25
-
misc26:
string
Miscellaneous 26
-
misc27:
string
Miscellaneous 27
-
misc28:
string
Miscellaneous 28
-
misc29:
string
Miscellaneous 29
-
misc3:
string
Miscellaneous 3
-
misc30:
string
Miscellaneous 30
-
misc4:
string
Miscellaneous 4
-
misc5:
string
Miscellaneous 5
-
misc6:
string
Miscellaneous 6
-
misc7:
string
Miscellaneous 7
-
misc8:
string
Miscellaneous 8
-
misc9:
string
Miscellaneous 9
-
noOfMiscFields:
integer
noOfMiscFields
Nested Schema : instrumentUdfFields
Type:
Show Source
array-
Array of:
object InstrumentUdfFieldsModel
InstrumentUdfFieldsModel
Nested Schema : DepositeSlipUdfFieldsModel
Type:
objectDepositeSlipUdfFieldsModel
Show Source
-
noOfUdfFields:
integer
No of Miscellaneous Fields
-
udf1:
string
User Defined Field 1
-
udf10:
string
User Defined Field 10
-
udf11:
string
User Defined Field 11
-
udf12:
string
User Defined Field 12
-
udf13:
string
User Defined Field 13
-
udf14:
string
User Defined Field 14
-
udf15:
string
User Defined Field 15
-
udf16:
string
User Defined Field 16
-
udf17:
string
User Defined Field 17
-
udf18:
string
User Defined Field 18
-
udf19:
string
User Defined Field 19
-
udf2:
string
User Defined Field 2
-
udf20:
string
User Defined Field 20
-
udf21:
string
User Defined Field 21
-
udf22:
string
User Defined Field 22
-
udf23:
string
User Defined Field 23
-
udf24:
string
User Defined Field 24
-
udf25:
string
User Defined Field 25
-
udf26:
string
User Defined Field 26
-
udf27:
string
User Defined Field 27
-
udf28:
string
User Defined Field 28
-
udf29:
string
User Defined Field 29
-
udf3:
string
User Defined Field 3
-
udf30:
string
User Defined Field 30
-
udf4:
string
User Defined Field 4
-
udf5:
string
User Defined Field 5
-
udf6:
string
User Defined Field 6
-
udf7:
string
User Defined Field 7
-
udf8:
string
User Defined Field 8
-
udf9:
string
User Defined Field 9
Nested Schema : InstrumentUdfFieldsModel
Type:
objectInstrumentUdfFieldsModel
Show Source
-
noOfUdfFields:
integer
No Of Miscellaneous Fields
-
udf1:
string
User Defined Field 1
-
udf10:
string
User Defined Field 10
-
udf11:
string
User Defined Field 11
-
udf12:
string
User Defined Field 12
-
udf13:
string
User Defined Field 13
-
udf14:
string
User Defined Field 14
-
udf15:
string
User Defined Field 15
-
udf16:
string
User Defined Field 16
-
udf17:
string
User Defined Field 17
-
udf18:
string
User Defined Field 18
-
udf19:
string
User Defined Field 19
-
udf2:
string
User Defined Field 2
-
udf20:
string
User Defined Field 20
-
udf21:
string
User Defined Field 21
-
udf22:
string
User Defined Field 22
-
udf23:
string
User Defined Field 23
-
udf24:
string
User Defined Field 24
-
udf25:
string
User Defined Field 25
-
udf26:
string
User Defined Field 26
-
udf27:
string
User Defined Field 27
-
udf28:
string
User Defined Field 28
-
udf29:
string
User Defined Field 29
-
udf3:
string
User Defined Field 3
-
udf30:
string
User Defined Field 30
-
udf4:
string
User Defined Field 4
-
udf5:
string
User Defined Field 5
-
udf6:
string
User Defined Field 6
-
udf7:
string
User Defined Field 7
-
udf8:
string
User Defined Field 8
-
udf9:
string
User Defined Field 9
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
500 Response
Internal error