Jump to

• Request
• Response

Fetch the charges details

get

/service/v1/chargeEnquiry

This endpoint is used to fetch the charges details based on given parameters.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• applicationCode: string
  Application Code
• branchCode(optional): string
  Branch Code
• chargeAccount(optional): string
  Charge Account
• chargeCode(optional): string
  Charge Code
• chargeGroup(optional): string
  Charge Group
• chargeType(optional): string
  Charge Type
• collectionType(optional): string
  Collection Type
• currency(optional): string
  Currency
• dateRefBasis(optional): string
  Date Reference Basis
• event(optional): string
  Event
• fromAmt(optional): number
  From Amount
• fromDate(optional): string
  From Date
• limit(optional): integer
  Limit is Maximum No Of Records To Be Fetched
• offset(optional): integer
  Offset Is Starting No Of Records To Be Fetched
• party(optional): string
  Party
• partyRole(optional): string
  Party Role
• product(optional): string
  Product
• status(optional): string
  Status
• toAmt(optional): number
  To Amount
• toDate(optional): string
  To Date
• txnRefNo(optional): string
  Transaction Reference Number

Header Parameters

• appId: string
  App id
• authToken(optional): string
  Authorization Token
• branchCode: string
  Branch Code
• branchDate(optional): string(date-time)
  Branch Date
• contentType(optional): string
  Content Type
• tenantId(optional): string
  Tenant id
• userId: string
  User Id for SMS

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Provides fetched charge details

Body ()

Root Schema : ChargeEnquiryDetailCollection

Type: object

Show Source

• chargeDetails(optional): array chargeDetails
  Charge Ddtails
• paging(optional): object paging

{
    "type":"object",
    "properties":{
        "chargeDetails":{
            "type":"array",
            "description":"Charge Ddtails",
            "items":{
                "$ref":"#/definitions/ChargeEnquiryDetailsModel"
            }
        },
        "paging":{
            "type":"object"
        }
    }
}

Nested Schema : chargeDetails

Type: array

Charge Ddtails

Show Source

• Array of: object ChargeEnquiryDetailsModel

{
    "type":"array",
    "description":"Charge Ddtails",
    "items":{
        "$ref":"#/definitions/ChargeEnquiryDetailsModel"
    }
}

Nested Schema : paging

Type: object

Nested Schema : ChargeEnquiryDetailsModel

Type: object

Show Source

• allowOverride(optional): string
  Allow Override
• allowPrcModify(optional): string
  Allow Prc Modify
• allowWaive(optional): string
  Allow Waive
• applicationCode(optional): string
  Application Code
• autoWaive(optional): string
  Auto Waive
• baseAmount(optional): number
  Base Amount
• baseAmountCcy(optional): string
  Base Amount Currency
• baseCount(optional): number
  Base Count
• branchCode(optional): string
  Branch Code
• calcEndDate(optional): string
  Calculate End Date
• calcFreq(optional): string
  Calculate Frequency
• calcRefPeriod(optional): string
  Calculate Reference Period
• calcStartDate(optional): string
  Calculate Start Date
• calcType(optional): string
  Calculate Type
• calcUnits(optional): number
  Calculate Units
• chargeAccount(optional): string
  Charge Account
• chargeAmt(optional): number
  Charge Amount
• 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
• chargeType(optional): string
  Charge Type
• chgCalcDate(optional): string
  Charge Calculate Date
• chgInTxnCcy(optional): string
  Charge In Transaction Currency
• chgSharing(optional): string
  Charge Sharing
• chgSharingPct(optional): number
  Charge Sharing Pct
• collectionFreq(optional): string
  Collection Frequency
• collectionRefPeriod(optional): string
  Collection Reference Period
• collectionType(optional): string
  Collection Type
• collectionUnits(optional): number
  Collection Units
• creditDebitStatus(optional): string
  Credit/Debit Status
• currency(optional): string
  Currency
• event(optional): string
  Event
• exchangeRate(optional): number
  Exchange Rate
• fixedAmt(optional): number
  Fixed Amount
• fixedPct(optional): number
  Fixed Pct
• flatCharge(optional): string
  Flat Charge
• instrumentStatus(optional): string
  Instrument Status
• instrumentType(optional): string
  Instrument Type
• maxAmt(optional): number
  Maximum Amount
• maxPct(optional): number
  Maximum Pct
• minAmt(optional): number
  Minimum Amount
• minmaxCriteria(optional): string
  Minimum Maximum Criteria
• minPct(optional): number
  Minimum Pct
• modNo(optional): number
  Mod Number
• parentChgCode(optional): string
  Parent Charge Code
• parentChgCodeDesc(optional): string
  Parent Charge Code Description
• party(optional): string
  Party
• partyId(optional): string
  Party Id
• partyRole(optional): string
  Party Role
• postingDate(optional): string
  Posting Date
• prcCategory(optional): string
  Prc Category
• prcCcy(optional): string
  Prc Currency
• priceMethodDesc(optional): string
  Price Method Description
• priceTemplateId(optional): string
  Price Template Id
• product(optional): string
  Product
• referenceEndDate(optional): string
  Reference End Date
• referenceStartDate(optional): string
  Reference Start Date
• slabDetails(optional): array slabDetails
  Slab Details
• txnCcy(optional): string
  Transaction Currency
• txnRefNo(optional): string
  Transaction Reference Number

{
    "type":"object",
    "properties":{
        "applicationCode":{
            "type":"string",
            "description":"Application Code"
        },
        "branchCode":{
            "type":"string",
            "description":"Branch Code"
        },
        "event":{
            "type":"string",
            "description":"Event"
        },
        "party":{
            "type":"string",
            "description":"Party"
        },
        "partyId":{
            "type":"string",
            "description":"Party Id"
        },
        "partyRole":{
            "type":"string",
            "description":"Party Role"
        },
        "product":{
            "type":"string",
            "description":"Product"
        },
        "chargeCode":{
            "type":"string",
            "description":"Charge Code"
        },
        "chargeCodeDesc":{
            "type":"string",
            "description":"Charge Code Description"
        },
        "chargeGroup":{
            "type":"string",
            "description":"Charge Group"
        },
        "chargeType":{
            "type":"string",
            "description":"Charge Type"
        },
        "instrumentType":{
            "type":"string",
            "description":"Instrument Type"
        },
        "chargeAccount":{
            "type":"string",
            "description":"Charge Account"
        },
        "collectionType":{
            "type":"string",
            "description":"Collection Type"
        },
        "txnRefNo":{
            "type":"string",
            "description":"Transaction Reference Number"
        },
        "postingDate":{
            "type":"string",
            "description":"Posting Date"
        },
        "currency":{
            "type":"string",
            "description":"Currency"
        },
        "chargeAmt":{
            "type":"number",
            "description":"Charge Amount"
        },
        "chgCalcDate":{
            "type":"string",
            "description":"Charge Calculate Date"
        },
        "calcStartDate":{
            "type":"string",
            "description":"Calculate Start Date"
        },
        "calcEndDate":{
            "type":"string",
            "description":"Calculate End Date"
        },
        "calcType":{
            "type":"string",
            "description":"Calculate Type"
        },
        "calcFreq":{
            "type":"string",
            "description":"Calculate Frequency"
        },
        "parentChgCode":{
            "type":"string",
            "description":"Parent Charge Code"
        },
        "parentChgCodeDesc":{
            "type":"string",
            "description":"Parent Charge Code Description"
        },
        "baseAmount":{
            "type":"number",
            "description":"Base Amount"
        },
        "baseAmountCcy":{
            "type":"string",
            "description":"Base Amount Currency"
        },
        "baseCount":{
            "type":"number",
            "description":"Base Count"
        },
        "priceTemplateId":{
            "type":"string",
            "description":"Price Template Id"
        },
        "modNo":{
            "type":"number",
            "description":"Mod Number"
        },
        "calcRefPeriod":{
            "type":"string",
            "description":"Calculate Reference Period"
        },
        "calcUnits":{
            "type":"number",
            "description":"Calculate Units"
        },
        "chargeCategory":{
            "type":"string",
            "description":"Charge Category"
        },
        "chargeCriteria":{
            "type":"string",
            "description":"Charge Criteria"
        },
        "chargeCriteriaValue":{
            "type":"number",
            "description":"Charge Criteria Value"
        },
        "chgInTxnCcy":{
            "type":"string",
            "description":"Charge In Transaction Currency"
        },
        "chgSharing":{
            "type":"string",
            "description":"Charge Sharing"
        },
        "chgSharingPct":{
            "type":"number",
            "description":"Charge Sharing Pct"
        },
        "collectionFreq":{
            "type":"string",
            "description":"Collection Frequency"
        },
        "collectionRefPeriod":{
            "type":"string",
            "description":"Collection Reference Period"
        },
        "collectionUnits":{
            "type":"number",
            "description":"Collection Units"
        },
        "exchangeRate":{
            "type":"number",
            "description":"Exchange Rate"
        },
        "fixedAmt":{
            "type":"number",
            "description":"Fixed Amount"
        },
        "fixedPct":{
            "type":"number",
            "description":"Fixed Pct"
        },
        "flatCharge":{
            "type":"string",
            "description":"Flat Charge"
        },
        "maxAmt":{
            "type":"number",
            "description":"Maximum Amount"
        },
        "maxPct":{
            "type":"number",
            "description":"Maximum Pct"
        },
        "minAmt":{
            "type":"number",
            "description":"Minimum Amount"
        },
        "minPct":{
            "type":"number",
            "description":"Minimum Pct"
        },
        "minmaxCriteria":{
            "type":"string",
            "description":"Minimum Maximum Criteria"
        },
        "prcCategory":{
            "type":"string",
            "description":"Prc Category"
        },
        "prcCcy":{
            "type":"string",
            "description":"Prc Currency"
        },
        "priceMethodDesc":{
            "type":"string",
            "description":"Price Method Description"
        },
        "referenceEndDate":{
            "type":"string",
            "description":"Reference End Date"
        },
        "referenceStartDate":{
            "type":"string",
            "description":"Reference Start Date"
        },
        "txnCcy":{
            "type":"string",
            "description":"Transaction Currency"
        },
        "allowOverride":{
            "type":"string",
            "description":"Allow Override"
        },
        "allowPrcModify":{
            "type":"string",
            "description":"Allow Prc Modify"
        },
        "allowWaive":{
            "type":"string",
            "description":"Allow Waive"
        },
        "autoWaive":{
            "type":"string",
            "description":"Auto Waive"
        },
        "slabDetails":{
            "description":"Slab Details",
            "type":"array",
            "items":{
                "$ref":"#/definitions/SlabDetails"
            }
        },
        "instrumentStatus":{
            "type":"string",
            "description":"Instrument Status"
        },
        "creditDebitStatus":{
            "type":"string",
            "description":"Credit/Debit Status"
        }
    }
}

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