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