Jump to

• Request
• Response

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(required): string
  Application Id
• branchCode(required): string
  Branch Code
• userId(required): string
  User Id

Body ()

Request Body For Charge Calculation

Root Schema : ChargeCalculationRequestDto

Type: object

Show Source

• applicationCode: string
• extPrcConsumerService: string
  Consumer Service Name
• txnDetails: array txnDetails

{
    "type":"object",
    "properties":{
        "applicationCode":{
            "type":"string"
        },
        "extPrcConsumerService":{
            "type":"string",
            "description":"Consumer Service Name"
        },
        "txnDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TransactionDetailsRequestDto"
            }
        }
    }
}

Nested Schema : txnDetails

Type: array

Show Source

• Array of: object TransactionDetailsRequestDto

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TransactionDetailsRequestDto"
    }
}

Nested Schema : TransactionDetailsRequestDto

Type: object

Show Source

• priceMethods: array priceMethods
  Details of each charge to be calculated
• txnAttributes: array txnAttributes
• txnRefNo: string

{
    "type":"object",
    "properties":{
        "txnRefNo":{
            "type":"string"
        },
        "priceMethods":{
            "description":"Details of each charge to be calculated",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChargeCalculationDetails"
            }
        },
        "txnAttributes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TransactionAttribute"
            }
        }
    }
}

Nested Schema : priceMethods

Type: array

Details of each charge to be calculated

Show Source

• Array of: object ChargeCalculationDetails

{
    "description":"Details of each charge to be calculated",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ChargeCalculationDetails"
    }
}

Nested Schema : txnAttributes

Type: array

Show Source

• Array of: object TransactionAttribute

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TransactionAttribute"
    }
}

Nested Schema : ChargeCalculationDetails

Type: object

Show Source

• charge: number
  Charge
• chargeCategory: string
  Charge Category
• chargeCode: string
  Charge Code
• chargeCodeDesc: string
  Charge Code Description
• chargeCriteria: string
  Amount/Count on which charge needs to be calculated. e.g. FINANCE_AMOUNT, INVOICE_COUNT
• chargeCriteriaValue: number
  Amount/Count Value on which charge needs to be calculated
• chargeGroup: string
  Charge Group
• 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
• exchangeRate: number
  Exchange Rate
• externalPricingApplicable: string
  External Pricing Applicable
• externalPricingConsumerService: string
  External Pricing Consumer Service
• externalPricingSystem: string
  External Pricing System
• isChargeCalculated: string
  Is Charge Calculated
• parentChargeCode: string
  Parent Charge Code
• partyId: string
  Party Id which needs to be charged
• partyToCharge: string
  Party which needs to be charged
• priceRuleId: string
  Pricing Rule Id
• slabDetails: array slabDetails
  Slab details needs to be provided when price category is tier based
• slidingScaleTenor: number
  Period for sliding scale
• tenor: number
  Period for which charge will be calculated
• txnCcy: string
  Transaction currency. It should be sent when chargeInTxnCcy is Y

{
    "type":"object",
    "properties":{
        "partyId":{
            "description":"Party Id which needs to be charged",
            "type":"string"
        },
        "chargeCode":{
            "description":"Charge Code",
            "type":"string"
        },
        "chargeCodeDesc":{
            "description":"Charge Code Description",
            "type":"string"
        },
        "parentChargeCode":{
            "description":"Parent Charge Code",
            "type":"string"
        },
        "chargeGroup":{
            "description":"Charge Group",
            "type":"string"
        },
        "chargeCategory":{
            "description":"Charge Category",
            "type":"string"
        },
        "chargeType":{
            "description":"Charge Type",
            "type":"string"
        },
        "chargeSharing":{
            "description":"Flag to indicate if charge sharing is available",
            "type":"string"
        },
        "partyToCharge":{
            "description":"Party which needs to be charged",
            "type":"string"
        },
        "chargeSharingPct":{
            "description":"Percentage of charge which will be charged to the given party",
            "type":"number"
        },
        "chargeCriteria":{
            "description":"Amount/Count on which charge needs to be calculated. e.g. FINANCE_AMOUNT, INVOICE_COUNT",
            "type":"string"
        },
        "chargeCriteriaValue":{
            "description":"Amount/Count Value on which charge needs to be calculated",
            "type":"number"
        },
        "tenor":{
            "description":"Period for which charge will be calculated",
            "type":"number"
        },
        "slidingScaleTenor":{
            "description":"Period for sliding scale",
            "type":"number"
        },
        "txnCcy":{
            "description":"Transaction currency. It should be sent when chargeInTxnCcy is Y",
            "type":"string"
        },
        "priceRuleId":{
            "description":"Pricing Rule Id",
            "type":"string"
        },
        "exchangeRate":{
            "description":"Exchange Rate",
            "type":"number"
        },
        "externalPricingApplicable":{
            "type":"string",
            "description":"External Pricing Applicable"
        },
        "externalPricingSystem":{
            "type":"string",
            "description":"External Pricing System"
        },
        "externalPricingConsumerService":{
            "type":"string",
            "description":"External Pricing Consumer Service"
        },
        "isChargeCalculated":{
            "type":"string",
            "description":"Is Charge Calculated"
        },
        "charge":{
            "type":"number",
            "description":"Charge"
        },
        "slabDetails":{
            "description":"Slab details needs to be provided when price category is tier based",
            "type":"array",
            "items":{
                "$ref":"#/definitions/SlabDetails"
            }
        }
    }
}

Nested Schema : slabDetails

Type: array

Slab details needs to be provided when price category is tier based

Show Source

• Array of: object SlabDetails

{
    "description":"Slab details needs to be provided when price category is tier based",
    "type":"array",
    "items":{
        "$ref":"#/definitions/SlabDetails"
    }
}

Nested Schema : SlabDetails

Type: object

Show Source

• amount: number
  Amount
• fromSlab: number
  From Slab
• percentage: number
  Percentage
• toSlab: number
  To Slab
• unit: number
  Unit

{
    "type":"object",
    "properties":{
        "fromSlab":{
            "type":"number",
            "description":"From Slab"
        },
        "toSlab":{
            "type":"number",
            "description":"To Slab"
        },
        "amount":{
            "type":"number",
            "description":"Amount"
        },
        "percentage":{
            "type":"number",
            "description":"Percentage"
        },
        "unit":{
            "type":"number",
            "description":"Unit"
        }
    }
}

Nested Schema : TransactionAttribute

Type: object

Show Source

• attrName: string
• attrValue: string

{
    "type":"object",
    "properties":{
        "attrName":{
            "type":"string"
        },
        "attrValue":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Calculated charges

Body ()

Root Schema : ChargesResponseDto

Type: object

Show Source

• applicationCode: string
• txnDetails: array txnDetails

{
    "type":"object",
    "properties":{
        "applicationCode":{
            "type":"string"
        },
        "txnDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TransactionDetailsResponseDto"
            }
        }
    }
}

Nested Schema : txnDetails

Type: array

Show Source

• Array of: object TransactionDetailsResponseDto

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TransactionDetailsResponseDto"
    }
}

Nested Schema : TransactionDetailsResponseDto

Type: object

Show Source

• chargeDetails: array chargeDetails
  Collection of calculated charges
• txnRefNo: string

{
    "type":"object",
    "properties":{
        "txnRefNo":{
            "type":"string"
        },
        "chargeDetails":{
            "description":"Collection of calculated charges",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChargesDetails"
            }
        }
    }
}

Nested Schema : chargeDetails

Type: array

Collection of calculated charges

Show Source

• Array of: object ChargesDetails

{
    "description":"Collection of calculated charges",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ChargesDetails"
    }
}

Nested Schema : ChargesDetails

Type: object

Show Source

• charge: number
  Calculated charge amount
• chargeCcy: string
  Currency in which charge is calculated
• chargeCode: string
  Charge Code
• chargeSharing: string
  Charge Sharing
• exchangeRate: number
  Exchange rate will be provided if charge is calculated in transaction currency
• externalCharge: string
  Party Id which needs to be charged
• maxChgAmount: number
  Maximum Charge Amount
• maxChgPct: number
  Maximum Charge Percentage
• minChgAmount: number
  Minimum Charge Amount
• minChgPct: number
  Minimum Charge Percentage
• minMaxValidationCriteria: string
  Min-Max Charge Criteria
• partyId: string
  Party Id which needs to be charged
• partyToCharge: string
  Party which needs to be charged
• priceMethod: string
  Price method which will be used to calculate charge
• priceRuleId: string
  Pricing Rule Id

{
    "type":"object",
    "properties":{
        "externalCharge":{
            "description":"Party Id which needs to be charged",
            "type":"string"
        },
        "partyId":{
            "description":"Party Id which needs to be charged",
            "type":"string"
        },
        "chargeCode":{
            "description":"Charge Code",
            "type":"string"
        },
        "partyToCharge":{
            "description":"Party which needs to be charged",
            "type":"string"
        },
        "priceMethod":{
            "description":"Price method which will be used to calculate charge",
            "type":"string"
        },
        "priceRuleId":{
            "description":"Pricing Rule Id",
            "type":"string"
        },
        "charge":{
            "description":"Calculated charge amount",
            "type":"number"
        },
        "chargeCcy":{
            "description":"Currency in which charge is calculated",
            "type":"string"
        },
        "chargeSharing":{
            "type":"string",
            "description":"Charge Sharing"
        },
        "exchangeRate":{
            "description":"Exchange rate will be provided if charge is calculated in transaction currency",
            "type":"number"
        },
        "minMaxValidationCriteria":{
            "type":"string",
            "description":"Min-Max Charge Criteria"
        },
        "maxChgAmount":{
            "type":"number",
            "description":"Maximum Charge Amount"
        },
        "maxChgPct":{
            "type":"number",
            "description":"Maximum Charge Percentage"
        },
        "minChgAmount":{
            "type":"number",
            "description":"Minimum Charge Amount"
        },
        "minChgPct":{
            "type":"number",
            "description":"Minimum Charge Percentage"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top