Calculate the charges
post
/service/v1/charges
This endpoint is used to calculate the charges based on given parameters.
Request
Supported Media Types
- application/json
- application/xml
Header Parameters
-
appId: string
Application Id
-
branchCode: string
Branch Code
-
userId: string
User Id
Request Body For Charge Calculation
Nested Schema : TransactionDetailsRequestDto
Type:
Show Source
object
-
priceMethods(optional):
array priceMethods
Details of each charge to be calculated
-
txnAttributes(optional):
array txnAttributes
-
txnRefNo(optional):
string
Nested Schema : ChargeCalculationDetails
Type:
Show Source
object
-
charge(optional):
number
Charge
-
chargeCategory(optional):
string
Charge Category
-
chargeCode(optional):
string
Charge Code
-
chargeCodeDesc(optional):
string
Charge Code Description
-
chargeCriteria(optional):
string
Amount/Count on which charge needs to be calculated. e.g. FINANCE_AMOUNT, INVOICE_COUNT
-
chargeCriteriaValue(optional):
number
Amount/Count Value on which charge needs to be calculated
-
chargeGroup(optional):
string
Charge Group
-
chargeSharing(optional):
string
Flag to indicate if charge sharing is available
-
chargeSharingPct(optional):
number
Percentage of charge which will be charged to the given party
-
chargeType(optional):
string
Charge Type
-
exchangeRate(optional):
number
Exchange Rate
-
externalPricingApplicable(optional):
string
External Pricing Applicable
-
externalPricingSystem(optional):
string
External Pricing System
-
isChargeCalculated(optional):
string
Is Charge Calculated
-
parentChargeCode(optional):
string
Parent Charge Code
-
partyId(optional):
string
Party Id which needs to be charged
-
partyToCharge(optional):
string
Party which needs to be charged
-
priceRuleId(optional):
string
Pricing Rule Id
-
slabDetails(optional):
array slabDetails
Slab details needs to be provided when price category is tier based
-
slidingScaleTenor(optional):
number
Period for sliding scale
-
tenor(optional):
number
Period for which charge will be calculated
-
txnCcy(optional):
string
Transaction currency. It should be sent when chargeInTxnCcy is Y
Nested Schema : slabDetails
Type:
array
Slab details needs to be provided when price category is tier based
Show Source
Nested Schema : SlabDetails
Type:
Show Source
object
-
amount(optional):
number
Amount
-
fromSlab(optional):
number
From Slab
-
percentage(optional):
number
Percentage
-
toSlab(optional):
number
To Slab
-
unit(optional):
number
Unit
Response
Supported Media Types
- application/json
- application/xml
200 Response
Calculated charges
Nested Schema : TransactionDetailsResponseDto
Type:
Show Source
object
-
chargeDetails(optional):
array chargeDetails
Collection of calculated charges
-
txnRefNo(optional):
string
Nested Schema : ChargesDetails
Type:
Show Source
object
-
charge(optional):
number
Calculated charge amount
-
chargeCcy(optional):
string
Currency in which charge is calculated
-
chargeCode(optional):
string
Charge Code
-
chargeSharing(optional):
string
Charge Sharing
-
exchangeRate(optional):
number
Exchange rate will be provided if charge is calculated in transaction currency
-
externalCharge(optional):
string
Party Id which needs to be charged
-
maxChgAmount(optional):
number
Maximum Charge Amount
-
maxChgPct(optional):
number
Maximum Charge Percentage
-
minChgAmount(optional):
number
Minimum Charge Amount
-
minChgPct(optional):
number
Minimum Charge Percentage
-
minMaxValidationCriteria(optional):
string
Min-Max Charge Criteria
-
partyId(optional):
string
Party Id which needs to be charged
-
partyToCharge(optional):
string
Party which needs to be charged
-
priceMethod(optional):
string
Price method which will be used to calculate charge
-
priceRuleId(optional):
string
Pricing Rule Id
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
500 Response
Internal error