Creates cash withdrawal transaction
put
/service/v1/cashWithdrawalInquiry
This endpoint creates the cash withdrawal transaction.
Request
Supported Media Types
- application/json
- application/xml
Header Parameters
-
appId(required): string
Application ID for SMS
-
authToken: string
Authentication Token
-
branchCode(required): string
Unique Branch Code
-
contentType: string
Content of a file
-
tenantId: string
Tenant ID for SMS
-
userId(required): string
User id for SMS
Request Body that contains data required for creating a new CashWithdrawal Entry
Root Schema : CashWithdrawalEntryRequestModel
Type:
object
Collection of CashWithdrawal Request Model
Show Source
-
cashWithdrawalEntryData:
object CashWithDrawalEntryModel
Cash Withdrawal Enquiry Model
Nested Schema : CashWithDrawalEntryModel
Type:
object
Cash Withdrawal Enquiry Model
Show Source
-
action:
string
Action
-
amount:
number
Amount
-
amtAccCcy:
number
Amount Account Ccy
-
authStat:
string
Authorization Status
-
branchCode:
string
branchCode
-
cashWithdrawalEnquiryDenominationfFieldsData:
array cashWithdrawalEnquiryDenominationfFieldsData
-
channel:
string
Channel
-
channelWithdrawalBranch:
string
Channel Withdrawal Branch
-
checkerDtStamp:
string
CheckerDateStamp
-
checkerId:
string
Checker Id
-
checkerRemarks:
string
Checker Remarks
-
chequeDate:
string
Cheque Date
-
chequeNo:
string
Cheque Number
-
consignmentDate:
string
Consignment Date
-
consignmentNo:
string
Consignment Number
-
contactNo:
string
Contact Number
-
corporateId:
string
Corporate Id
-
corporateName:
string
Corporate Name
-
corporateRefNo:
string
Corporate Reference Number
-
courierCode:
string
Courier Code
-
currency:
string
Currency
-
cwAccRefNo:
string
CashWithdrawal Account Reference Number
-
debitAccountNo:
string
Debit Account Number
-
debitACCY:
string
Debit Account CCY
-
debitDate:
string
Debit Date
-
debitStatus:
string
Debit Status
-
deliveryPointCode:
string
Delivery Point Code
-
deliveryPointDesc:
string
Delivery Point Description
-
denominationCount:
number
Denomination Count
-
exchangeRate:
number
Exchange Rate
-
externalChannel:
string
External Channel
-
extReferenceNo:
string
External Reference Number
-
id:
string
Id of the cashwithdrawal
-
idProofDetail:
string
Id Proof Detail
-
idProofType:
string
Id Proof Type
-
lienAmount:
number
Lien Amount
-
lienDate:
string
Lien Date
-
lienNumber:
string
Lien Number
-
lienStatus:
string
Lien Status
-
makerDtStamp:
string
MakerDateStamp
-
makerId:
string
Maker Id
-
makerRemarks:
string
Maker Remarks
-
misc1:
string
1st Miscellaneous Field
-
misc10:
string
10th Miscellaneous Field
-
misc11:
string
11th Miscellaneous Field
-
misc12:
string
12th Miscellaneous Field
-
misc13:
string
13th Miscellaneous Field
-
misc14:
string
14th Miscellaneous Field
-
misc15:
string
15th Miscellaneous Field
-
misc16:
string
16th Miscellaneous Field
-
misc17:
string
17th Miscellaneous Field
-
misc18:
string
18th Miscellaneous Field
-
misc19:
string
19th Miscellaneous Field
-
misc2:
string
2nd Miscellaneous Field
-
misc20:
string
20th Miscellaneous Field
-
misc21:
string
21st Miscellaneous Field
-
misc22:
string
22nd Miscellaneous Field
-
misc23:
string
23rd Miscellaneous Field
-
misc24:
string
24th Miscellaneous Field
-
misc25:
string
25th Miscellaneous Field
-
misc26:
string
26th Miscellaneous Field
-
misc27:
string
27th Miscellaneous Field
-
misc28:
string
28th Miscellaneous Field
-
misc29:
string
29th Miscellaneous Field
-
misc3:
string
3rd Miscellaneous Field
-
misc30:
string
30th Miscellaneous Field
-
misc4:
string
4th Miscellaneous Field
-
misc5:
string
5th Miscellaneous Field
-
misc6:
string
6th Miscellaneous Field
-
misc7:
string
7th Miscellaneous Field
-
misc8:
string
8th Miscellaneous Field
-
misc9:
string
9th Miscellaneous Field
-
modNo:
integer
Mod No of the cashwithdrawal
-
noOfMiscFields:
number
noOfMiscFields
-
onceAuth:
string
Once Authorization
-
processingDate:
string
Processing Date
-
processingStatus:
string
Stage
-
recipientName:
string
recipient Name
-
recipientType:
string
Recipient Type
-
recordStat:
string
Record Status
-
requestedDate:
string
Requested Date
-
slipNo:
string
Slip Number
-
stage:
string
Stage
-
transactionRefNo:
string
Transaction Reference Number
-
vaFlagYN:
string
Virtual Account Falg(Y/N)
-
withdrawalDate:
string
Channel Withdrawal Date
-
withdrawalSlipDate:
string
WithdrawalSlipDate
Nested Schema : cashWithdrawalEnquiryDenominationfFieldsData
Type:
Show Source
array
-
Array of:
object CashWithdrawalEnquiryDenominationFieldsModel
Collection of CashWithdrawal Enquiry Denomination Fields Model
Nested Schema : CashWithdrawalEnquiryDenominationFieldsModel
Type:
object
Collection of CashWithdrawal Enquiry Denomination Fields Model
Show Source
-
checkerDtStamp:
string
CheckerDateStamp
-
checkerId:
string
Checker Id
-
denominationAmount:
number
Denomination Amount
-
denominationCount:
number
Denomination Count
-
denominationRefNo:
string
Denomination Reference Number
-
denominationType:
string
Denomination Type
-
denominationValue:
number
Denomination Value
-
depositSlipNo:
number
DepositSlip Number
-
depositSlipRefNo:
string
DepositSlip Reference Number
-
id:
string
Id for Denomination
-
makerDtStamp:
string
MakerDateStamp
-
makerId:
string
Maker Id
-
referenceNum:
string
Reference Number
-
seqNo:
number
Seq No
Response
Supported Media Types
- application/json
- application/xml
200 Response
Successful performs the operation
Root Schema : CashWithdrawalEntryResponseModel
Type:
object
Collection of CashWithdrawal Response Model
Show Source
-
cashWithdrawalEntryData:
object CashWithDrawalEntryModel
Cash Withdrawal Enquiry Model
-
errors:
object errors
List Of Errors
-
responseStatus:
string
Response Status
Nested Schema : CashWithDrawalEntryModel
Type:
object
Cash Withdrawal Enquiry Model
Show Source
-
action:
string
Action
-
amount:
number
Amount
-
amtAccCcy:
number
Amount Account Ccy
-
authStat:
string
Authorization Status
-
branchCode:
string
branchCode
-
cashWithdrawalEnquiryDenominationfFieldsData:
array cashWithdrawalEnquiryDenominationfFieldsData
-
channel:
string
Channel
-
channelWithdrawalBranch:
string
Channel Withdrawal Branch
-
checkerDtStamp:
string
CheckerDateStamp
-
checkerId:
string
Checker Id
-
checkerRemarks:
string
Checker Remarks
-
chequeDate:
string
Cheque Date
-
chequeNo:
string
Cheque Number
-
consignmentDate:
string
Consignment Date
-
consignmentNo:
string
Consignment Number
-
contactNo:
string
Contact Number
-
corporateId:
string
Corporate Id
-
corporateName:
string
Corporate Name
-
corporateRefNo:
string
Corporate Reference Number
-
courierCode:
string
Courier Code
-
currency:
string
Currency
-
cwAccRefNo:
string
CashWithdrawal Account Reference Number
-
debitAccountNo:
string
Debit Account Number
-
debitACCY:
string
Debit Account CCY
-
debitDate:
string
Debit Date
-
debitStatus:
string
Debit Status
-
deliveryPointCode:
string
Delivery Point Code
-
deliveryPointDesc:
string
Delivery Point Description
-
denominationCount:
number
Denomination Count
-
exchangeRate:
number
Exchange Rate
-
externalChannel:
string
External Channel
-
extReferenceNo:
string
External Reference Number
-
id:
string
Id of the cashwithdrawal
-
idProofDetail:
string
Id Proof Detail
-
idProofType:
string
Id Proof Type
-
lienAmount:
number
Lien Amount
-
lienDate:
string
Lien Date
-
lienNumber:
string
Lien Number
-
lienStatus:
string
Lien Status
-
makerDtStamp:
string
MakerDateStamp
-
makerId:
string
Maker Id
-
makerRemarks:
string
Maker Remarks
-
misc1:
string
1st Miscellaneous Field
-
misc10:
string
10th Miscellaneous Field
-
misc11:
string
11th Miscellaneous Field
-
misc12:
string
12th Miscellaneous Field
-
misc13:
string
13th Miscellaneous Field
-
misc14:
string
14th Miscellaneous Field
-
misc15:
string
15th Miscellaneous Field
-
misc16:
string
16th Miscellaneous Field
-
misc17:
string
17th Miscellaneous Field
-
misc18:
string
18th Miscellaneous Field
-
misc19:
string
19th Miscellaneous Field
-
misc2:
string
2nd Miscellaneous Field
-
misc20:
string
20th Miscellaneous Field
-
misc21:
string
21st Miscellaneous Field
-
misc22:
string
22nd Miscellaneous Field
-
misc23:
string
23rd Miscellaneous Field
-
misc24:
string
24th Miscellaneous Field
-
misc25:
string
25th Miscellaneous Field
-
misc26:
string
26th Miscellaneous Field
-
misc27:
string
27th Miscellaneous Field
-
misc28:
string
28th Miscellaneous Field
-
misc29:
string
29th Miscellaneous Field
-
misc3:
string
3rd Miscellaneous Field
-
misc30:
string
30th Miscellaneous Field
-
misc4:
string
4th Miscellaneous Field
-
misc5:
string
5th Miscellaneous Field
-
misc6:
string
6th Miscellaneous Field
-
misc7:
string
7th Miscellaneous Field
-
misc8:
string
8th Miscellaneous Field
-
misc9:
string
9th Miscellaneous Field
-
modNo:
integer
Mod No of the cashwithdrawal
-
noOfMiscFields:
number
noOfMiscFields
-
onceAuth:
string
Once Authorization
-
processingDate:
string
Processing Date
-
processingStatus:
string
Stage
-
recipientName:
string
recipient Name
-
recipientType:
string
Recipient Type
-
recordStat:
string
Record Status
-
requestedDate:
string
Requested Date
-
slipNo:
string
Slip Number
-
stage:
string
Stage
-
transactionRefNo:
string
Transaction Reference Number
-
vaFlagYN:
string
Virtual Account Falg(Y/N)
-
withdrawalDate:
string
Channel Withdrawal Date
-
withdrawalSlipDate:
string
WithdrawalSlipDate
Nested Schema : cashWithdrawalEnquiryDenominationfFieldsData
Type:
Show Source
array
-
Array of:
object CashWithdrawalEnquiryDenominationFieldsModel
Collection of CashWithdrawal Enquiry Denomination Fields Model
Nested Schema : CashWithdrawalEnquiryDenominationFieldsModel
Type:
object
Collection of CashWithdrawal Enquiry Denomination Fields Model
Show Source
-
checkerDtStamp:
string
CheckerDateStamp
-
checkerId:
string
Checker Id
-
denominationAmount:
number
Denomination Amount
-
denominationCount:
number
Denomination Count
-
denominationRefNo:
string
Denomination Reference Number
-
denominationType:
string
Denomination Type
-
denominationValue:
number
Denomination Value
-
depositSlipNo:
number
DepositSlip Number
-
depositSlipRefNo:
string
DepositSlip Reference Number
-
id:
string
Id for Denomination
-
makerDtStamp:
string
MakerDateStamp
-
makerId:
string
Maker Id
-
referenceNum:
string
Reference Number
-
seqNo:
number
Seq No
Nested Schema : Error
Type:
object
Error Model
Show Source
-
errorCode:
string
Error Code
-
errorDescription:
string
Error Description
-
errorStatus:
string
Error Status
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
500 Response
Internal error