Online charges for Cheque Collection
get
/service/v1/collectionChequeCharges
This API calculates the online charges for Cheque Collection
Request
Supported Media Types
- application/json
- application/xml
Header Parameters
-
appId(required): string
App Id for SMS
-
applicationCode(required): string
Application Code for SMS
-
branchCode(required): string
Branch Code for SMS
-
event(required): string
Event
-
tenantId: string
Tenant Id for SMS
-
userId(required): string
User Id for SMS
Response
Supported Media Types
- application/json
- application/xml
200 Response
Successful performs the operation
Nested Schema : ObChargesTxnDTO
Type:
Show Source
object
-
allowOverride:
string
Allow Override
-
allowPrcModify:
string
Allow PrcModify
-
allowWaive:
string
Allow Waive
-
applicationCode:
string
Application Code
-
autoWaive:
string
Auto Waive
-
branchCode:
string
Branch Code
-
calcEndDate:
string(date)
Calculate End Date
-
calcErrorCode:
string
CalcErrorCode
-
calcFreq:
string
Calc Freq
-
calcRefPeriod:
string
Calc RefPeriod
-
calcStartDate:
string(date)
Calculate Start Date
-
calcType:
string
Calc Type
-
calcUnits:
number
Calc Units
-
chargeAmount:
number
Charge Amount
-
chargeCategory:
string
Charge Category
-
chargeCode:
string
Charge Code
-
chargeCodeDesc:
string
Charge Code Description
-
chargeCriteria:
string
Charge Criteria
-
chargeCriteriaValue:
number
Charge Criteria Value
-
chargeGroup:
string
Charge Group
-
chargeType:
string
Charge Type
-
chgCalcDate:
string(date)
Charge Calculate Date
-
chgCriteriaCcy:
string
Charge Criteria Currency
-
chgCriteriaCount:
string
Charge Criteria Count
-
chgSharing:
string
Charge Sharing
-
chgSharingPct:
number
Charge Sharing Pct
-
collectionFreq:
string
Collection Frequency
-
collectionRefPeriod:
string
Collection Reference Period
-
collectionType:
string
Collection Type
-
collectionUnits:
number
Collection Units
-
creditAccNumber:
string
Credit Account Number
-
debitAccNumber:
string
Debit Account Number
-
eventCode:
string
Event Code
-
exchangeRate:
number
Exchange Rate
-
externalPricing:
string
External Pricing Flag
-
externalPricingConsumerService:
string
External Pricing Consumer Service Name
-
externalPricingIdDescription:
string
External Pricing Identifier Description/Price Component Code Description
-
externalPricingIdentifier:
string
External Pricing Identifier/Price Component Code
-
externalPricingSystem:
string
External Pricing System
-
externalPricingSystemName:
string
External Pricing System Name
-
firstChgCalcDate:
string(date)
First Charge Calculate Date
-
firstChgCollDate:
string(date)
First Charge Collection Date
-
instrumentType:
string
Instrument Type
-
isExternalPrc:
string
External Pricing Flag
-
nextChgCalcDate:
string(date)
Next Charge Caculate Date
-
nextChgCollDate:
string(date)
Next Charge Collection Date
-
parentChargeCode:
string
Parent Charge Code
-
partyId:
string
Party Id
-
partyName:
string
Party Name
-
partyToCharge:
string
Party To Charge
-
postingErrorCode:
string
Posting Error Code
-
priceMethodDesc:
string
Price Method Description
-
priceTemplateId:
string
Price Template Id
-
referenceEndDate:
string
Reference End Date
-
referenceEndDateValue:
string(date)
Reference End Date Value
-
referenceStartDate:
string
Reference Start Date
-
referenceStartDateValue:
string(date)
Reference Start Date Value
-
scheduleDetails:
array scheduleDetails
Charge Schedule Details Collection
-
txnCcy:
string
Transaction Currency
-
txnRefNo:
string
Transaction Reference Number
Nested Schema : ChargeScheduleDetails
Type:
Show Source
object
-
calculationTenor:
number
Calculation Tenor
-
chargeAmt:
number
Charge Amount
-
chargeCalcDate:
string
Charge Calculation Date
-
chargeCalcEndDate:
string
Tenor End Date
-
chargeCalcStartDate:
string
Tenor Start Date
-
chargeCalcStatus:
string
Charge Collection Status
-
chargeCollDate:
string
Charge Collection Date
-
chargeCollStatus:
string
Charge Collection Status
-
chgCcy:
string
Charge Currency
-
chgCollectionAmt:
number
Original Charge Amount
-
nextChargeCalcDate:
string
Next Charge Calculation Date
-
nextChargeCollDate:
string
Next Charge Collection Date
-
oldChgAmt:
number
Original Charge Amount
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not auhorized.
500 Response
Internal error