Fetche charges details
get
/service/v1/chargeEnquiry
This endpoint is used to fetch the charges details based on given parameters.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
applicationCode(required): string
Application Code
-
branchCode: string
Branch Code
-
chargeAccount: string
Charge Account
-
chargeCode: string
Charge Code
-
chargeGroup: string
Charge Group
-
chargeStatus: string
Charge Status
-
chargeType: string
Charge Type
-
collectionType: string
Collection Type
-
currency: string
Currency
-
dateRefBasis: string
Date Reference Basis
-
event: string
Event
-
fromAmt: number
From Amount
-
fromDate: string
From Date
-
isExtPricing: string
Is External Pricing
-
limit: integer
Limit is Maximum No Of Records To Be Fetched
-
offset: integer
Offset Is Starting No Of Records To Be Fetched
-
party: string
Party
-
partyRole: string
Party Role
-
product: string
Product
-
status: string
Status
-
toAmt: number
To Amount
-
toDate: string
To Date
-
txnRefNo: string
Transaction Reference Number
Header Parameters
-
appId(required): string
App id
-
authToken: string
Authorization Token
-
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
Response
Supported Media Types
- application/json
- application/xml
200 Response
Provides fetched charge details
Root Schema : ChargeEnquiryDetailCollection
Type:
Show Source
object
-
chargeDetails:
array chargeDetails
Charge Ddtails
-
paging:
object paging
Nested Schema : paging
Type:
object
Nested Schema : ChargeEnquiryDetailsModel
Type:
Show Source
object
-
allowOverride:
string
Allow Override
-
allowPrcModify:
string
Allow Prc Modify
-
allowWaive:
string
Allow Waive
-
applicationCode:
string
Application Code
-
autoWaive:
string
Auto Waive
-
baseAmount:
number
Base Amount
-
baseAmountCcy:
string
Base Amount Currency
-
baseCount:
number
Base Count
-
branchCode:
string
Branch Code
-
calcEndDate:
string
Calculate End Date
-
calcFreq:
string
Calculate Frequency
-
calcRefPeriod:
string
Calculate Reference Period
-
calcStartDate:
string
Calculate Start Date
-
calcType:
string
Calculate Type
-
calcUnits:
number
Calculate Units
-
chargeAccount:
string
Charge Account
-
chargeAmt:
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
Charge Calculate Date
-
chgInTxnCcy:
string
Charge In Transaction Currency
-
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
-
creditDebitStatus:
string
Credit/Debit Status
-
currency:
string
Currency
-
event:
string
Event
-
exchangeRate:
number
Exchange Rate
-
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
-
fixedAmt:
number
Fixed Amount
-
fixedPct:
number
Fixed Pct
-
flatCharge:
string
Flat Charge
-
instrumentStatus:
string
Instrument Status
-
instrumentType:
string
Instrument Type
-
isAutoWaived:
string
Is Auto Waived Flag
-
isExternalPrc:
string
External Pricing Flag
-
isModified:
string
Is Modified Flag
-
isOverridden:
string
Is Overridden Flag
-
isWaived:
string
Is Waived Flag
-
maxAmt:
number
Maximum Amount
-
maxPct:
number
Maximum Pct
-
minAmt:
number
Minimum Amount
-
minmaxCriteria:
string
Minimum Maximum Criteria
-
minPct:
number
Minimum Pct
-
modNo:
number
Mod Number
-
oldChargeAmount:
number
Old Charge Amount
-
oldPrcTemplateDesc:
string
Old Price Rule Description
-
oldPriceTemplateId:
string
Old Price Rule Id
-
parentChgCode:
string
Parent Charge Code
-
parentChgCodeDesc:
string
Parent Charge Code Description
-
party:
string
Party
-
partyId:
string
Party Id
-
partyRole:
string
Party Role
-
postingDate:
string
Posting Date
-
prcCategory:
string
Prc Category
-
prcCcy:
string
Prc Currency
-
prcTemplateDesc:
string
Price Rule Description
-
priceMethodDesc:
string
Price Method Description
-
priceTemplateId:
string
Price Rule Id
-
product:
string
Product
-
referenceEndDate:
string
Reference End Date
-
referenceStartDate:
string
Reference Start Date
-
scheduleDetails:
array scheduleDetails
Charge Schedule Details Collection
-
seqNo:
string
Sequence Number
-
slabDetails:
array slabDetails
Slab Details
-
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
Nested Schema : SlabDetails
Type:
Show Source
object
-
amount:
number
Amount needs to be provided when price category is Tier Based Amount or Tier Based Mixed
-
fromSlab:
number
From Slab
-
percentage:
number
Amount needs to be provided when price category is Tier Based Percent or Tier Based Mixed
-
toSlab:
number
To Slab
-
unit:
number
unit specifies the charge amount to be levied per unit
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
500 Response
Internal error