Fetch the pricing templates
post
/service/v1/getChargeDetails
This endpoint is used to fetch the pricing templates based on given filter parameters.
Request
Supported Media Types
- application/json
- application/xml
Header Parameters
-
appId(required): string
App Id
-
branchCode(required): string
Branch code
-
userId(required): string
User Id
Charge filter parameters
Root Schema : ChargesRequestDto
Type:
object
Charges Request Dto
Show Source
-
applicationCode:
string
Application Code
-
category:
string
Category
-
chargeCodes:
array chargeCodes
-
txnMap:
object StringStringMap
Additional Properties Allowed: additionalProperties
Response
Supported Media Types
- application/json
- application/xml
200 Response
Best possible record from the pricing methods
Root Schema : ChargeCodeDetailsCollection
Type:
object
Charge Code Details Collection
Show Source
-
priceMethods:
array priceMethods
Price Methods
Nested Schema : ChargeCodeDetails
Type:
Show Source
object
-
allowOverride:
string
Allow Override
-
allowPrcModify:
string
Allow PrcModify
-
allowWaive:
string
Allow Waive
-
annumBasis:
number
Annual Basis
-
autoWaive:
string
Auto Waive
-
calcFreq:
string
Calc Frequency
-
calcRefPeriod:
string
Calc Reference Period
-
calcType:
string
Calc Type
-
calcUnits:
number
Calc Units
-
chargeCategory:
string
Charge Category
-
chargeCode:
string
Charge Code
-
chargeCodeDesc:
string
Charge Code Description
-
chargeCriteria:
string
Amount/Count on which charge needs to be calculated.
-
chargeCriteriaValue:
number
Amount/Count Value on which charge needs to be calculated
-
chargeGroup:
string
Charge Group
-
chargeInTxnCcy:
string
Charge in Txn CCY
-
chargeSharing:
string
Flag to indicate if charge sharing is available
-
chargeSharingPct:
number
Percentage of charge which will be charged to the given party
-
chargeType:
string
Charge Type
-
collectionFreq:
string
Collection Frequency
-
collectionRefPeriod:
string
Collection Reference Period
-
collectionType:
string
Collection Type
-
collectionUnits:
number
Collection Units
-
externalPricing:
string
External Pricing Flag
-
externalPricingIdDescription:
string
External Pricing Identifier Description/Price Component Code Description
-
externalPricingIdentifier:
string
External Pricing Identifier/Price Component Code
-
externalPricingSystem:
string
External Pricing System
-
fixedAmt:
number
Fixed Amount
-
fixedPct:
number
Fixed Percentage
-
flatCharge:
string
Flat Charge
-
parentChargeCode:
string
Parent Charge Code
-
partyId:
string
Party Id which needs to be charged
-
partyToCharge:
string
Party which needs to be charged
-
priceCcy:
string
Price CCY
-
priceMethod:
string
Price Method
-
priceMethodDesc:
string
Price Method Desc
-
priceTemplateId:
string
Price Template Id
-
referenceEndDate:
string
Reference End Date
-
referenceEndDateValue:
string
Reference End Date Value
-
referenceStartDate:
string
Reference Start Date
-
referenceStartDateValue:
string
Reference Start Date Value
-
slabDetails:
array slabDetails
Slab Details
-
tenor:
number
Tenor
-
txnCcy:
string
Transaction CCY
-
txnRefNo:
string
Transaction Ref No
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