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

Body ()

Request Body For Charge Calculation

Root Schema : ChargeCalculationRequestDto

Type: object

Show Source

• applicationCode(optional): string
  applicationCode
• txnDetails(optional): array txnDetails

{
    "type":"object",
    "properties":{
        "applicationCode":{
            "type":"string",
            "description":"applicationCode"
        },
        "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(optional): array priceMethods
  Details of each charge to be calculated
• txnAttributes(optional): array txnAttributes
• txnRefNo(optional): string
  Transaction Reference Number

{
    "type":"object",
    "properties":{
        "txnRefNo":{
            "type":"string",
            "description":"Transaction Reference Number"
        },
        "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

• 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

{
    "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"
        },
        "txnCcy":{
            "description":"Transaction currency. It should be sent when chargeInTxnCcy is Y",
            "type":"string"
        },
        "exchangeRate":{
            "description":"Exchange Rate",
            "type":"number"
        },
        "externalPricingApplicable":{
            "type":"string",
            "description":"External Pricing Applicable"
        },
        "externalPricingSystem":{
            "type":"string",
            "description":"External Pricing System"
        },
        "isChargeCalculated":{
            "type":"string",
            "description":"Is Charge Calculated"
        },
        "priceRuleId":{
            "type":"string",
            "description":"Price Rule Id"
        }
    }
}

Nested Schema : TransactionAttribute

Type: object

Show Source

• attrName(optional): string
  attrName
• attrValue(optional): string
  attrValue

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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Calculated charges

Body ()

Root Schema : ChargesResponseDto

Type: object

Show Source

• applicationCode(optional): string
  Application Code
• txnDetails(optional): array txnDetails

{
    "type":"object",
    "properties":{
        "applicationCode":{
            "type":"string",
            "description":"Application Code"
        },
        "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(optional): array chargeDetails
  Collection of calculated charges
• txnRefNo(optional): string
  Transaction Reference Number

{
    "type":"object",
    "properties":{
        "txnRefNo":{
            "type":"string",
            "description":"Transaction Reference Number"
        },
        "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(optional): number
  Charge
• chargeCcy(optional): string
  Charge Currency
• 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 Reference Number

{
    "type":"object",
    "properties":{
        "txnRefNo":{
            "type":"string",
            "description":"Transaction Reference Number"
        },
        "partyId":{
            "type":"string",
            "description":"Party Id"
        },
        "chargeCode":{
            "type":"string",
            "description":"Charge Code"
        },
        "partyToCharge":{
            "type":"string",
            "description":"Party To Charge"
        },
        "priceMethod":{
            "type":"string",
            "description":"Price Method"
        },
        "charge":{
            "type":"number",
            "description":"Charge"
        },
        "chargeCcy":{
            "type":"string",
            "description":"Charge Currency"
        },
        "exchangeRate":{
            "type":"number",
            "description":"Exchange Rate"
        }
    }
}

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