Create the instrument collection transaction
put
/service/v1/instrumentCollection/update
This endpoint is used to create the instrument collection transaction.
Request
Supported Media Types
- application/json
- application/xml
Header Parameters
-
appId(required): string
Application ID
-
authToken: string
AuthToken for SMS
-
branchCode(required): string
Branch Code
-
branchDate: string(date-time)
Branch Date
-
contentType: string
Content Type
-
tenantId: string
Tenant ID
-
userId(required): string
User id for SMS
Request Body that contains data required for updating instrument collections
Root Schema : InstrumentCollections
Type:
objectInstrumentCollections model
Show Source
-
collectionTxn:
object CollectionTxnModel
InstrumentCollections model
-
depositSlipTxn:
array depositSlipTxn
depositSlip
Nested Schema : CollectionTxnModel
Type:
objectInstrumentCollections model
Show Source
-
ackReceiptNo:
string
Ack Receipt Number
-
authDtStamp:
string
Authorization Date
-
authId:
string
Authorization Id
-
autoAuth:
string
Auto Authorization
-
bagWeight:
number
Bag weight
-
branchCode:
string
Branch code
-
channel:
string
External Channel Name
-
consignmentDate:
string
Consignment Date
-
consignmentNo:
string
Consignment Number
-
contactNumber:
string
Contact Number
-
courierCode:
string
Courier Code
-
courierDesc:
string
Courier Desc
-
depositChannel:
string
Deposit Channel
-
depositLocationCode:
string
Deposit Location Code
-
depositLocationDesc:
string
Deposit Location Description
-
depositorName:
string
Depositor Name
-
extRefNo:
string
External Reference Number
-
fileName:
string
File Name
-
financialPosting:
string
Financial Posting
-
id:
string
Id of the batch
-
idProofDetail:
string
ID Proof Detail
-
idProofType:
string
ID Proof Type
-
initiatorRefNo:
string
Initiator Reference Number
-
makerDateStamp:
string
MakerDateStamp
-
makerId:
string
Maker Id
-
processingDate:
string
Processing Date
-
referenceNum:
string
Reference Number
-
resourceId:
string
Resource Id
-
screenFlag:
string
Screen Flag Identifier
-
seqNo:
integer(int64)
Sequence Number
-
stage:
string
Stage
-
totalBatchAmt:
number
Total Batch Amount
-
totalBatchAmtCcy:
string
Total Batch Amount Currency
-
totalDepositSlips:
integer(int64)
Total Deposit Slips
-
txnStatus:
string
Transaction Status
Nested Schema : depositSlipTxn
Type:
arraydepositSlip
Show Source
-
Array of:
object DepositSlipTxnModel
DepositSlip Transaction model
Nested Schema : DepositSlipTxnModel
Type:
objectDepositSlip Transaction model
Show Source
-
channel:
string
External Channel Name
-
channelDepositBranch:
string
Branch where the cheque is required to be deposited
-
corporateId:
string
Corporate Id of the DepositSlip
-
corporateName:
string
Corporate Name of the DepositSlip
-
creditAccountNo:
string
CreditAccountNo of the DepositSlip
-
depositSlipAdFields:
object DepositSlipAdditionalFieldsModel
Collection of DepositSlips
-
depositSlipAmt:
number
Deposit Slip Amount
-
depositSlipAmtCcy:
string
DepositSlip Amount Currency
-
depositSlipCount:
integer(int64)
DepositSlip Count
-
depositSlipDate:
string
Deposit Slip Date
-
depositSlipNo:
string
No of the DepositSlipNo
-
depositSlipRefNo:
string
Deposit Slip Ref No of the slip
-
depositSlipValue:
number
DepositSlip Value
-
divisionCode:
string
Division Code
-
divisionDesc:
string
Division Description
-
errors:
object errors
List Of Errors
-
extRefNo:
string
External Reference Number
-
id:
string
Id of the DepositSlip
-
intrumentDetails:
object InstrumentDetTxn
Collection of Instruments Details Transaction
-
misc1:
string
Miscellaneous Field 1
-
misc10:
string
Miscellaneous Field 10
-
misc11:
string
Miscellaneous Field 11
-
misc12:
string
Miscellaneous Field 12
-
misc13:
string
Miscellaneous Field 13
-
misc14:
string
Miscellaneous Field 14
-
misc15:
string
Miscellaneous Field 15
-
misc16:
string
Miscellaneous Field 16
-
misc17:
string
Miscellaneous Field 17
-
misc18:
string
Miscellaneous Field 18
-
misc19:
string
Miscellaneous Field 19
-
misc2:
string
Miscellaneous Field 2
-
misc20:
string
Miscellaneous Field 20
-
misc21:
string
Miscellaneous Field 21
-
misc22:
string
Miscellaneous Field 22
-
misc23:
string
Miscellaneous Field 23
-
misc24:
string
Miscellaneous Field 24
-
misc25:
string
Miscellaneous Field 25
-
misc26:
string
Miscellaneous Field 26
-
misc27:
string
Miscellaneous Field 27
-
misc28:
string
Miscellaneous Field 28
-
misc29:
string
Miscellaneous Field 29
-
misc3:
string
Miscellaneous Field 3
-
misc30:
string
Miscellaneous Field 30
-
misc4:
string
Miscellaneous Field 4
-
misc5:
string
Miscellaneous Field 5
-
misc6:
string
Miscellaneous Field 6
-
misc7:
string
Miscellaneous Field 7
-
misc8:
string
Miscellaneous Field 8
-
misc9:
string
Miscellaneous Field 9
-
noOfInstruments:
integer(int64)
No Of Instruments
-
noOfMiscFields:
integer(int64)
No of Miscellaneous Fields
-
pickupDate:
string
Pick Date
-
pickupLocationCode:
string
Pick Up Location Code
-
pickupLocationDesc:
string
Pick Up Location Description
-
pickupPointCode:
string
Pick Up Point Code
-
pickupPointDesc:
string
Pick Up Point Description
-
referenceNum:
string
Reference Num of the DepositSlip
-
requestDate:
string
Request Date
-
seqNo:
integer(int64)
Seq No of the DepositSlip
Nested Schema : DepositSlipAdditionalFieldsModel
Type:
objectCollection of DepositSlips
Show Source
Nested Schema : InstrumentDetTxn
Type:
objectCollection of Instruments Details Transaction
Show Source
Nested Schema : DepositSlipAdditionalInfoList
Type:
Show Source
array-
Array of:
object DepositSlipAdditionalFieldsDto
DataSlips additional Field
Nested Schema : DepositSlipAdditionalFieldsDto
Type:
objectDataSlips additional Field
Show Source
-
adfRowNo:
integer(int64)
row no of this additional Field
-
depositSlipNo:
string
no of the DepositSlipNo
-
depositSlipRefNo:
string
deposit Slip Ref No of the slip
-
id:
string
Id of the DepositSlip
-
referenceNum:
string
Reference Num of the DepositSlip
-
seqNo:
integer(int64)
Seq No of the DepositSlip
-
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 : instrumentList
Type:
Show Source
array-
Array of:
object InstrumentDetTxnModel
Instrument Details Transaction model
Nested Schema : InstrumentDetTxnModel
Type:
objectInstrument Details Transaction model
Show Source
-
accountType:
string
Account Type
-
actualCreditDate:
string
Actual Credit Date
-
actualCreditReversalDate:
string
Actual Credit Reversal Date
-
adhocCharges:
number
Adhoc Charges
-
adjustedCreditRevAmt:
number
Adjusted Credit Reversal Amount
-
arrangementCode:
string
Arrangement Code
-
arrangementCreditDate:
string
arrangementCreditDate
-
arrangementCreditReversalDate:
string
Arrangment Credit Reversal Date
-
arrangementDays:
integer
Arrangement Days
-
arrangementDesc:
string
Arrangement Description
-
arrangementRefBasis:
string
Arrangement Reference Basis
-
balanceCreditRetRevAmt:
number
Balance Credit Reversal Amount
-
bankFloatArrangement:
string
Bank float Arrangement
-
centralizedSchdGenerationDate:
string
Centralized Scheduled Generation Date
-
certificateExtensionDays:
integer
Certification Extension Days
-
checkerDtStamp:
string
Checker Date
-
checkerId:
string
Checker ID
-
clearingNetworkCode:
string
Clearing Network Code
-
clearingNetworkDesc:
string
Clearing Network Description
-
coreBankBranchCode:
string
Corresponding Bank Branch Code
-
corporateRefNo:
string
Corporate Reference Number
-
corporateReleaseDays:
integer
Corporate Release Days
-
corrBankCode:
string
Correspondance Bank Code
-
creditAccountNo:
string
Credit Account Number
-
creditReversalFrom:
string
Credit Reversal From
-
creditReversalStatus:
string
Credit reversal Status
-
creditStatus:
string
Credit Status
-
depositSlipNo:
string
DepositSlip Number
-
depositSlipRefNo:
string
Deposit Slip Ref No of the Instrument
-
divisionCode:
string
Division Code
-
divisionCodeDesc:
string
Division Code Description
-
drawerAcName:
string
Drawer Account Name
-
drawerAcNo:
string
Drawer Account Number
-
drawerId:
string
Drawer Id
-
drawerName:
string
Drawer Name
-
drawnOnBankCode:
string
Drawn On Bank Code
-
drawnOnBankName:
string
Drawn On Bank Name
-
drawnOnBranchCode:
string
Drawn On Branch Code
-
drawnOnBranchName:
string
Drawn On Branch Name
-
expectedCreditReversalDate:
string
Expected Credit Reversal Date
-
financialPostingStatus:
string
Financial Posting Status
-
forcedDebitForRecovery:
string
Forced Debit for Recovery
-
holdUntillDate:
string
Hold Until Date
-
id:
string
Id of the Instrument
-
instMgmtCourierCode:
string
Instrument Management Courier Code
-
instMgmtCourierPodNumber:
string
Instrument management Corier Pod Number
-
instrumentAccRefNo:
string
Instrument Account number
-
instrumentAdFields:
object InstrumentDetailAdditionalFieldsModel
Collection of DepositSlips
-
instrumentAmountValue:
number
Instrument Amount Value
-
instrumentAmt:
number
Instrument Amount
-
instrumentAmtCcy:
string
Instrument Amount Cuurency
-
instrumentCount:
number
Instrument Count
-
instrumentDate:
string
Instrument Date
-
instrumentManagementBatchRefNo:
string
Instrument Management Batch Reference Number
-
instrumentNo:
string
No of the Instrument
-
instrumentRefNo:
string
Instrument Ref No of the Instrument
-
instrumentStatus:
string
Instrument Status
-
instrumentType:
string
Instrument Type
-
instTxnStatus:
string
Instrument Transaction Status
-
isCentralizedSchedule:
string
Is Centralized Scheduled
-
isCustomerCredited:
string
Checking Customer Credited or Not
-
isPDCChecked:
string
PDC Value Y or N
-
lostExtensionDays:
integer
Lost Extension Days
-
makerDtStamp:
string
Maker Date
-
makerId:
string
Maker Id
-
misc1:
string
Miscellaneous Field 1
-
misc10:
string
Miscellaneous Field 10
-
misc11:
string
Miscellaneous Field 11
-
misc12:
string
Miscellaneous Field 12
-
misc13:
string
Miscellaneous Field 13
-
misc14:
string
Miscellaneous Field 14
-
misc15:
string
Miscellaneous Field 15
-
misc16:
string
Miscellaneous Field 16
-
misc17:
string
Miscellaneous Field 17
-
misc18:
string
Miscellaneous Field 18
-
misc19:
string
Miscellaneous Field 19
-
misc2:
string
Miscellaneous Field 2
-
misc20:
string
Miscellaneous Field 20
-
misc21:
string
Miscellaneous Field 21
-
misc22:
string
Miscellaneous Field 22
-
misc23:
string
Miscellaneous Field 23
-
misc24:
string
Miscellaneous Field 24
-
misc25:
string
Miscellaneous Field 25
-
misc26:
string
Miscellaneous Field 26
-
misc27:
string
Miscellaneous Field 27
-
misc28:
string
Miscellaneous Field 28
-
misc29:
string
Miscellaneous Field 29
-
misc3:
string
Miscellaneous Field 3
-
misc30:
string
Miscellaneous Field 30
-
misc4:
string
Miscellaneous Field 4
-
misc5:
string
Miscellaneous Field 5
-
misc6:
string
Miscellaneous Field 6
-
misc7:
string
Miscellaneous Field 7
-
misc8:
string
Miscellaneous Field 8
-
misc9:
string
Miscellaneous Field 9
-
newInstrumentNo:
string
New Instrument Number
-
noOfMiscFields:
integer(int64)
No of Miscellaneous Fields
-
partialCreditReversal:
string
Partial credit Reversal
-
partialReturnRecovery:
string
Partial return recovery
-
payableAtLocationCode:
string
ayable At Location Code
-
payableAtLocationDesc:
string
Payable At Location Description
-
payableAtLocClusterCode:
string
Payable At Location Cluster Code
-
payableAtLocClusterDesc:
string
Payable At Location Cluster Description
-
presentationDate:
string
presentationDate
-
productCode:
string
Product Code
-
productDesc:
string
Product Description
-
realisationAmount:
number
Realisation Amount
-
realisationDate:
string
Realisation Date
-
referenceNum:
string
Reference Num of the Instrument
-
rejectReason:
string
Reject Reason
-
remarks:
string
Remarks
-
returnExtensionDays:
integer
Return Extension days
-
returningDate:
string
Returning Date
-
returnRecoveryDate:
string
Return Recovery Date
-
returnRecoveryFrom:
string
Return Recovery From
-
returnRecoveryStatus:
string
Return return recovery status
-
routingNumber:
string
Routing Number
-
scheduleDestinationBank:
string
Scheduled Destination Bank
-
scheduleDestinationBankDescription:
string
Scheduled Destination Bank Description
-
scheduleDestinationBranch:
string
Scheduled Destination Branch
-
scheduleDestinationBranchDescription:
string
Scheduled Destination Branch Description
-
scheduleGenerationDate:
string
Scheduled Generation Date
-
scheduleOriginationBank:
string
Scheduled Origination Bank
-
scheduleOriginationBranch:
string
Scheduled Origination Branch
-
scheduleReceiptDate:
string
Schedule Receipt Date
-
scheduleRefNo:
string
Scheduled Reference Number
-
seqNo:
integer(int64)
Seq No of the Instrument
-
stage:
string
Stage
-
vaultBoxDescription:
string
Vault Box Description
-
vaultBoxNumber:
string
Vault Box Number
-
vaultBranch:
string
Vault Box Branch
Nested Schema : InstrumentDetailAdditionalFieldsModel
Type:
objectCollection of DepositSlips
Show Source
Nested Schema : InstrumentModelAdditionalInfoList
Type:
Show Source
array-
Array of:
object InstrumentDetailAdditionalFieldsDto
DataSlips additional Field
Nested Schema : InstrumentDetailAdditionalFieldsDto
Type:
objectDataSlips additional Field
Show Source
-
adfRowNo:
integer(int64)
Row no of this additional Field
-
depositSlipRefNo:
string
deposit Slip Ref No of the slip
-
id:
string
Id of the DepositSlip
-
instrumentNo:
string
No of the instrument
-
instrumentRefNo:
string
No of the instrumentRefNo
-
referenceNum:
string
Reference Num of the DepositSlip
-
seqNo:
integer(int64)
Seq No of the DepositSlip
-
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
Response
Supported Media Types
- application/json
- application/xml
201 Response
Returns the Id of the updated instrument collection
Root Schema : InstrumentCollectionResponseModel
Type:
objectInstrument Collection Response Model
Show Source
-
DepositSlipTxnData:
object DepositSlipTxnData
DepositSlip Transaction Data
-
errors:
object errors
List Of Errors
-
InstCollTxnData:
object InstCollTxnData
Instrument Collection Traction Model
-
responseStatus:
string
Response Status
Nested Schema : DepositSlipTxnData
Type:
objectDepositSlip Transaction Data
Nested Schema : InstCollTxnData
Type:
objectInstrument Collection Traction Model
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
405 Response
Invalid input
500 Response
Internal error