Performs Charge Calculation
post
/service/v1/charges
This endpoint is used to performs Charge Calculation.
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 : txnDetails
Type:
Show Source
array
-
Array of:
object TransactionDetailsRequestDto
Transaction Details RequestDto
Nested Schema : TransactionDetailsRequestDto
Type:
object
Transaction Details RequestDto
Show Source
-
priceMethods(optional):
array priceMethods
Details of each charge to be calculated
-
txnAttributes(optional):
array txnAttributes
-
txnRefNo(optional):
string
Txn Ref No
Nested Schema : priceMethods
Type:
array
Details of each charge to be calculated
Show Source
-
Array of:
object ChargeCalculationDetails
Charge Calculation Details
Nested Schema : ChargeCalculationDetails
Type:
object
Charge Calculation Details
Show Source
-
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
Price Rule Id
-
tenor(optional):
number
Period for which charge will be calculated
-
txnCcy(optional):
string
Transaction currency. It should be sent when chargeInTxnCcy is Y
Response
Supported Media Types
- application/json
- application/xml
200 Response
Calculated charges
Root Schema : ChargesResponseDto
Type:
object
Charges Response Dto
Show Source
-
applicationCode(optional):
string
Application Code
-
txnDetails(optional):
array txnDetails
Nested Schema : txnDetails
Type:
Show Source
array
-
Array of:
object TransactionDetailsResponseDto
Transaction Details ResponseDto
Nested Schema : TransactionDetailsResponseDto
Type:
object
Transaction Details ResponseDto
Show Source
-
chargeDetails(optional):
array chargeDetails
Collection of calculated charges
-
txnRefNo(optional):
string
Txn Ref No
Nested Schema : chargeDetails
Type:
array
Collection of calculated charges
Show Source
-
Array of:
object ChargesDetails
Charges Details
Nested Schema : ChargesDetails
Type:
object
Charges Details
Show Source
-
charge(optional):
number
Charge
-
chargeCcy(optional):
string
Charge Ccy
-
chargeCode(optional):
string
Charge Code
-
exchangeRate(optional):
number
Exchange Rate
-
partyId(optional):
string
Party Id
-
partyToCharge(optional):
string
Party to Charge
-
priceMethod(optional):
string
Price Method
-
txnRefNo(optional):
string
Transaction Ref No
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
500 Response
Internal error