Jump to

• Request
• Response

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

Body ()

Charge filter parameters

Root Schema : ChargesRequestDto

Type: object

Show Source

• applicationCode(optional): string
  Application Code
• category(optional): string
  Category
• chargeCodes(optional): array chargeCodes
  List of Charge Codes
• txnMap(optional): object StringStringMap
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "properties":{
        "applicationCode":{
            "type":"string",
            "description":"Application Code"
        },
        "category":{
            "type":"string",
            "description":"Category"
        },
        "txnMap":{
            "$ref":"#/definitions/StringStringMap"
        },
        "chargeCodes":{
            "type":"array",
            "description":"List of Charge Codes",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : chargeCodes

Type: array

List of Charge Codes

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of Charge Codes",
    "items":{
        "type":"string"
    }
}

Nested Schema : StringStringMap

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Best possible record from the pricing methods

Body ()

Root Schema : ChargeCodeDetailsCollection

Type: object

Show Source

• priceMethods(optional): array priceMethods
  Price Methods

{
    "type":"object",
    "properties":{
        "priceMethods":{
            "description":"Price Methods",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChargeCodeDetails"
            }
        }
    }
}

Nested Schema : priceMethods

Type: array

Price Methods

Show Source

• Array of: object ChargeCodeDetails

{
    "description":"Price Methods",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ChargeCodeDetails"
    }
}

Nested Schema : ChargeCodeDetails

Type: object

Show Source

• allowOverride(optional): string
  Allow Override
• allowPrcModify(optional): string
  Allow Price Modify
• allowWaive(optional): string
  Allow Waive
• annumBasis(optional): number
  Annum Basis
• autoWaive(optional): string
  Auto Waive
• calcFreq(optional): string
  Calculation Frequency
• calcRefPeriod(optional): string
  Calculation Reference Period
• calcType(optional): string
  Calculation Type
• calcUnits(optional): number
  Calculation Units
• chargeCategory(optional): string
  Charge Category
• chargeCode(optional): string
  Charge Code
• chargeCodeDesc(optional): string
  Charge Code Description
• chargeCriteria(optional): string
  Charge Criteria
• chargeCriteriaValue(optional): number
  Charge Criteria Value
• chargeGroup(optional): string
  Charge Group
• chargeInTxnCcy(optional): string
  Charge In Transaction Currency
• chargeSharing(optional): string
  Charge Sharing
• chargeSharingPct(optional): number
  Charge Sharing Percentage
• chargeType(optional): string
  Charge Type
• collectionFreq(optional): string
  Collection Frequency
• collectionRefPeriod(optional): string
  Collection Reference Period
• collectionType(optional): string
  Collection Type
• collectionUnits(optional): number
  Collection Units
• fixedAmt(optional): number
  Fixed Amount
• fixedPct(optional): number
  Fixed Percentage
• flatCharge(optional): string
  Flat Charge
• parentChargeCode(optional): string
  Parent Charge Code
• partyId(optional): string
  Party Id
• partyToCharge(optional): string
  Party To Charge
• priceCcy(optional): string
  Price Currency
• priceMethod(optional): string
  Price Method
• priceMethodDesc(optional): string
  Price Method Description
• priceTemplateId(optional): string
  Price Template Id
• referenceEndDate(optional): string
  Reference End Date
• referenceEndDateValue(optional): string
  Reference End Date Value
• referenceStartDate(optional): string
  Reference Start Date
• referenceStartDateValue(optional): string
  Reference Start Date Value
• slabDetails(optional): array slabDetails
  Slab Details
• tenor(optional): number
  Tenor
• txnCcy(optional): string
  Transaction Currency
• txnRefNo(optional): string
  Transaction Reference Number

{
    "type":"object",
    "properties":{
        "txnRefNo":{
            "type":"string",
            "description":"Transaction Reference Number"
        },
        "chargeCode":{
            "type":"string",
            "description":"Charge Code"
        },
        "chargeCodeDesc":{
            "type":"string",
            "description":"Charge Code Description"
        },
        "parentChargeCode":{
            "type":"string",
            "description":"Parent Charge Code"
        },
        "chargeGroup":{
            "type":"string",
            "description":"Charge Group"
        },
        "chargeCategory":{
            "type":"string",
            "description":"Charge Category"
        },
        "chargeType":{
            "type":"string",
            "description":"Charge Type"
        },
        "chargeSharing":{
            "type":"string",
            "description":"Charge Sharing"
        },
        "chargeSharingPct":{
            "type":"number",
            "description":"Charge Sharing Percentage"
        },
        "partyId":{
            "type":"string",
            "description":"Party Id"
        },
        "partyToCharge":{
            "type":"string",
            "description":"Party To Charge"
        },
        "chargeCriteria":{
            "type":"string",
            "description":"Charge Criteria"
        },
        "chargeCriteriaValue":{
            "type":"number",
            "description":"Charge Criteria Value"
        },
        "referenceStartDate":{
            "type":"string",
            "description":"Reference Start Date"
        },
        "referenceStartDateValue":{
            "type":"string",
            "description":"Reference Start Date Value"
        },
        "referenceEndDate":{
            "type":"string",
            "description":"Reference End Date"
        },
        "referenceEndDateValue":{
            "type":"string",
            "description":"Reference End Date Value"
        },
        "tenor":{
            "type":"number",
            "description":"Tenor"
        },
        "priceTemplateId":{
            "type":"string",
            "description":"Price Template Id"
        },
        "priceMethod":{
            "type":"string",
            "description":"Price Method"
        },
        "priceMethodDesc":{
            "type":"string",
            "description":"Price Method Description"
        },
        "txnCcy":{
            "type":"string",
            "description":"Transaction Currency"
        },
        "priceCcy":{
            "type":"string",
            "description":"Price Currency"
        },
        "chargeInTxnCcy":{
            "type":"string",
            "description":"Charge In Transaction Currency"
        },
        "flatCharge":{
            "type":"string",
            "description":"Flat Charge"
        },
        "fixedAmt":{
            "type":"number",
            "description":"Fixed Amount"
        },
        "fixedPct":{
            "type":"number",
            "description":"Fixed Percentage"
        },
        "annumBasis":{
            "type":"number",
            "description":"Annum Basis"
        },
        "allowWaive":{
            "type":"string",
            "description":"Allow Waive"
        },
        "autoWaive":{
            "type":"string",
            "description":"Auto Waive"
        },
        "allowOverride":{
            "type":"string",
            "description":"Allow Override"
        },
        "collectionType":{
            "type":"string",
            "description":"Collection Type"
        },
        "collectionFreq":{
            "type":"string",
            "description":"Collection Frequency"
        },
        "collectionRefPeriod":{
            "type":"string",
            "description":"Collection Reference Period"
        },
        "collectionUnits":{
            "type":"number",
            "description":"Collection Units"
        },
        "calcType":{
            "type":"string",
            "description":"Calculation Type"
        },
        "calcFreq":{
            "type":"string",
            "description":"Calculation Frequency"
        },
        "calcRefPeriod":{
            "type":"string",
            "description":"Calculation Reference Period"
        },
        "calcUnits":{
            "type":"number",
            "description":"Calculation Units"
        },
        "allowPrcModify":{
            "type":"string",
            "description":"Allow Price Modify"
        },
        "slabDetails":{
            "description":"Slab Details",
            "type":"array",
            "items":{
                "$ref":"#/definitions/SlabDetails"
            }
        }
    }
}

Nested Schema : slabDetails

Type: array

Slab Details

Show Source

• Array of: object SlabDetails

{
    "description":"Slab Details",
    "type":"array",
    "items":{
        "$ref":"#/definitions/SlabDetails"
    }
}

Nested Schema : SlabDetails

Type: object

Show Source

• amount(optional): number
  Amount
• fromSlab(optional): number
  From Slab
• percentage(optional): number
  Percentage
• toSlab(optional): number
  To Slab
• unit(optional): 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"
        }
    }
}

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