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